Merge pull request #121 from blacklanternsecurity/uv

Migrate to uv + Auto Docker Publishing

Author: TheTechromancer

.dockerignore

@@ -1 +1,2 @@
-mongodb/ 
+mongodb/
+.venv/ 

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/docker-tests.yml

@@ -14,18 +14,16 @@ jobs:
   docker-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
       - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.11"
+        run: uv python install 3.11
       - name: Install dependencies
-        run: |
-          pip install poetry
-          poetry install
+        run: uv sync
       - name: Run tests
         run: |
-          BBOT_SERVER_TEST_DOCKER_COMPOSE=true poetry run pytest --disable-warnings --log-cli-level=INFO -k test_docker_compose
+          BBOT_SERVER_TEST_DOCKER_COMPOSE=true uv run pytest --disable-warnings --log-cli-level=INFO -k test_docker_compose
 
   docker-publish:
     runs-on: ubuntu-latest
@@ -36,6 +34,17 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v6
 
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+
+    - name: Get version from pyproject.toml
+      id: version
+      run: |
+        VERSION=$(uv version --short)
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
+        echo "major=$(echo $VERSION | cut -d. -f1)" >> $GITHUB_OUTPUT
+        echo "minor=$(echo $VERSION | cut -d. -f1-2)" >> $GITHUB_OUTPUT
+
     - name: Set up Docker Buildx
       uses: docker/setup-buildx-action@v3
 
@@ -55,9 +64,9 @@ jobs:
           type=ref,event=pr
           type=sha,prefix=sha-
           type=raw,value=latest,enable={{is_default_branch}}
-          type=raw,value=v1
-          type=raw,value=v1.0
-          type=raw,value=v1.0.0
+          type=raw,value=v${{ steps.version.outputs.major }}
+          type=raw,value=v${{ steps.version.outputs.minor }}
+          type=raw,value=v${{ steps.version.outputs.version }}
 
     - name: Build and push Docker image
       uses: docker/build-push-action@v6
@@ -72,19 +81,19 @@ jobs:
       run: |
         # Install jq for JSON processing
         sudo apt-get update && sudo apt-get install -y jq
-        
+
         echo "Cleaning up bbot-server tags..."
-        
+
         tags_response=$(curl -s -H "Authorization: Bearer ${{ secrets.DOCKER_TOKEN }}" \
           "https://hub.docker.com/v2/repositories/bbot-server}/tags/?page_size=100")
-        
+
         tags_to_delete=$(echo "$tags_response" | jq -r '.results[] | select(.name != "latest") | [.last_updated, .name] | @tsv' | \
           sort -r | tail -n +51 | cut -f2)
-        
+
         for tag in $tags_to_delete; do
           echo "Deleting bbot-server tag: $tag"
           curl -X DELETE -H "Authorization: Bearer ${{ secrets.DOCKER_TOKEN }}" \
             "https://hub.docker.com/v2/repositories/bbot-server/tags/$tag/"
         done
-        
-        echo "Cleanup completed for bbot-server. Kept 50 most recent tags plus 'latest'."
+
+        echo "Cleanup completed for bbot-server. Kept 50 most recent tags plus 'latest'."

.github/workflows/tests.yml

@@ -27,24 +27,22 @@ jobs:
         ports:
           - 127.0.0.1:6379:6379
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
       - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
       - name: Install dependencies
-        run: |
-          pip install poetry
-          poetry install
+        run: uv sync
       - name: Lint
         run: |
-          poetry run ruff check
-          poetry run ruff format --check
+          uv run ruff check
+          uv run ruff format --check
       - name: Run tests
         run: |
-          NO_COLOR=true poetry run pytest --reruns 2 --disable-warnings --log-cli-level=INFO --cov-report xml:cov.xml --cov=bbot_server .
+          NO_COLOR=true uv run pytest --reruns 2 --disable-warnings --log-cli-level=INFO --cov-report xml:cov.xml --cov=bbot_server .
       - name: Upload Code Coverage
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./cov.xml

Dockerfile

@@ -1,9 +1,8 @@
-FROM python:3.11
-RUN apt-get -y update
-RUN apt-get -y install curl jq
+FROM ghcr.io/astral-sh/uv:python3.11-trixie
+RUN apt-get -y update && apt-get -y install curl jq
 COPY . /app
 WORKDIR /app
-# install bbot_server in editable mode
-RUN pip install -e .
+RUN uv sync --frozen
+ENV PATH="/app/.venv/bin:$PATH"
 EXPOSE 8807
-CMD ["bbctl", "server", "start", "--api-only"]
+CMD ["uv", "run", "bbctl", "server", "start", "--api-only"]

README.md

@@ -27,11 +27,15 @@ BBOT Server is a database and multiplayer hub for all your [BBOT](https://github
 # clone the repo and cd into it
 git clone git@github.com:blacklanternsecurity/bbot-server.git && cd bbot-server
 
-# Install in editable mode
-pipx install -e .
+# Install dependencies and create virtual environment
+uv sync
 ```
 
-Note: to update to the latest version, run `git pull` in the `bbot-server` directory.
+Note: to update to the latest version, run `git pull && uv sync` in the `bbot-server` directory.
+
+To install `uv`, see the [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/).
+
+Commands shown below as `bbctl` can be run with `uv run bbctl` from the project directory, or you can activate the virtual environment first with `source .venv/bin/activate`.
 
 ## Start the server
 
@@ -459,10 +463,10 @@ Then execute `pytest`:
 
 ```bash
 # run all tests
-poetry run pytest -v
+uv run pytest -v
 
 # run specific tests
-poetry run pytest -v -k test_applet_scans
+uv run pytest -v -k test_applet_scans
 ```
 
 ## Screenshots

bbot_server/__init__.py

@@ -1,6 +1,12 @@
 import os
+from importlib.metadata import version, PackageNotFoundError
 from pathlib import Path
 
+try:
+    __version__ = version("bbot-server")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
 BBOT_SERVER_PROJECT_ROOT = Path(__file__).parent.parent
 
 # set up logging
@@ -17,4 +23,4 @@
 from .interfaces import BBOTServer
 
 
-__all__ = ["BBOTServer", "BBOT_SERVER_DIR", "BBOT_SERVER_CONFIG", "BBOT_SERVER_PROJECT_ROOT"]
+__all__ = ["BBOTServer", "BBOT_SERVER_DIR", "BBOT_SERVER_CONFIG", "BBOT_SERVER_PROJECT_ROOT", "__version__"]

bbot_server/cli/themes.py

@@ -1,27 +1,14 @@
-import typer
-# from textual.theme import Theme
+from typer import rich_utils
 
 COLOR = "bold dark_orange"
 DARK_COLOR = "grey50"
 
-# # textual theme
-# TEXTUAL_THEME = Theme(
-#     name="bbot",
-#     primary="#000000",
-#     secondary="#1a1a1a",
-#     accent="#FF8400",
-#     warning="#FF8400",
-#     error="#ff4500",
-#     success="#FF8400",
-#     foreground="#ffffff",
-# )
-
 # typer theme
-typer.rich_utils.STYLE_OPTION = "bold dark_orange"
-typer.rich_utils.STYLE_NEGATIVE_OPTION = "bold red"
-typer.rich_utils.STYLE_NEGATIVE_SWITCH = "bold red"
-typer.rich_utils.STYLE_SWITCH = "bold orange1"
-typer.rich_utils.STYLE_USAGE = "bright_white"
-typer.rich_utils.STYLE_METAVAR = "bold dark_orange"
-typer.rich_utils.STYLE_OPTION_ENVVAR = "dim orange1"
-typer.rich_utils.STYLE_COMMANDS_TABLE_FIRST_COLUMN = "bold dark_orange"
+rich_utils.STYLE_OPTION = "bold dark_orange"
+rich_utils.STYLE_NEGATIVE_OPTION = "bold red"
+rich_utils.STYLE_NEGATIVE_SWITCH = "bold red"
+rich_utils.STYLE_SWITCH = "bold orange1"
+rich_utils.STYLE_USAGE = "bright_white"
+rich_utils.STYLE_METAVAR = "bold dark_orange"
+rich_utils.STYLE_OPTION_ENVVAR = "dim orange1"
+rich_utils.STYLE_COMMANDS_TABLE_FIRST_COLUMN = "bold dark_orange"

compose.yml

@@ -4,7 +4,7 @@ x-bbot-server-base: &bbot-server-base
   restart: unless-stopped
   volumes:
     - "${BBOT_SERVER_CONFIG:-~/.config/bbot_server/config.yml}:/root/.config/bbot_server/config.yml"
-    - .:/app
+    - ./bbot_server:/app/bbot_server
     - ./bbot_server/defaults_docker.yml:/app/bbot_server/defaults.yml
 
 services: