Convert to Python project, replace pipenv with uv (#205)

* Refactor bot.py to have a `main()` function

* Create pip-installable setuptools package

* Switch from PEP 735 Dependency Groups to PEP 508 Extra Dependencies

Pip does not yet support this (PR merged, not released, general availability might take years)

* Move from explicit package declaration to src-layout

* Revert "Switch from PEP 735 Dependency Groups to PEP 508 Extra Dependencies"

This reverts commit 979ac19.

* Add uv files

* Replace pipenv with uv

* Raise Python version from 3.11.4 to 3.11.12

* Remove outdated configuration

* Delete pipenv files

* Fix isort configuration

Ensure 'src/*' is classified as 'first-party' code

* Update README

* Add license information to pyproject.toml

* Add trailing newline

* Add 'uv lock --upgrade' to README

* Adapt dependabot config to use uv

Author: NMertsch

.dockerignore

@@ -3,4 +3,3 @@
 .idea
 .vscode
 Dockerfile
-pyproject.toml

.github/dependabot.yml

@@ -1,6 +1,6 @@
 version: 2
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "weekly"

.github/workflows/ci.yml

@@ -16,22 +16,26 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11.4'
+          version: "0.6.14"
+
+      - name: Set up Python
+        run: uv python install
 
-      - name: Install pipenv
-        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
-      - run: pipenv install --dev
+      - name: Install dev dependencies
+        run: uv sync --dev
 
       - name: Run Black
-        run: pipenv run black --check .
+        run: uv run --dev black --check .
 
       - name: Run Flake8
-        run: pipenv run flake8 .
+        run: uv run --dev flake8 .
 
       - name: Run isort
-        run: pipenv run isort --check .
+        run: uv run --dev isort --check .
 
   test:
     name: 🛠️ Test Python code
@@ -42,14 +46,16 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: '3.11.4'
+          version: "0.6.14"
 
-      - name: Install pipenv
-        run: curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python
-      - run: pipenv install --dev
+      - name: Set up Python
+        run: uv python install
 
-      - name: Run pytest
-        run: pipenv run pytest .
+      - name: Install dev dependencies
+        run: uv sync --dev
 
+      - name: Run pytest
+        run: uv run --dev pytest .

.github/workflows/deploy.yml

@@ -14,7 +14,7 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11.4'
+          python-version: '3.11.12'
 
       - name: Install Ansible
         run: |

.gitignore

@@ -9,3 +9,4 @@ __pycache__
 registered_log.txt
 schedule.json
 pretix_cache.json
+*.egg-info/

.python-version

@@ -0,0 +1 @@
+3.11.12

Dockerfile

@@ -1,4 +1,5 @@
-FROM python:3.11.4-slim
+FROM python:3.11.12-slim
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/
 
 RUN groupadd --gid 1000 bot && \
     useradd --uid 1000 --gid bot bot --create-home && \
@@ -7,16 +8,9 @@ RUN groupadd --gid 1000 bot && \
 USER bot
 WORKDIR /home/bot
 
-RUN pip install --upgrade --user pip && rm -rf /home/bot/.cache
-RUN pip install --user pipenv && rm -rf /home/bot/.cache
-RUN rm -rf /home/bot/.cache
-
 ENV PATH="/home/bot/.local/bin:$PATH"
 
-COPY --chown=bot:bot Pipfile Pipfile.lock ./
-COPY --chown=bot:bot EuroPythonBot ./EuroPythonBot
-
-RUN pipenv sync && \
-    rm -rf /home/bot/.cache
+COPY --chown=bot:bot pyproject.toml uv.lock ./
+COPY --chown=bot:bot src ./src
 
-ENTRYPOINT ["pipenv", "run", "python", "EuroPythonBot/bot.py"]
+ENTRYPOINT ["uv", "run", "run-bot"]

Pipfile

@@ -26,92 +26,93 @@ There are safeguard methods in place to prevent users from registering multiple
 Is a service to push the programme notification to Discord. Pretalx API is used to fetch the programme information, and `config.toml` holds information about livestream URLs.
 
 ### Organizers extension
+
 A set of commands that are available only for organizers that are allowing to get statistics about the Discord server.
 
 ## Setup
-### Install Python, Pipenv, Pyenv (Ubuntu)
-```shell
-# dependencies of readline, sqlite3, ctypes
-sudo apt install libreadline-dev libsqlite3-dev lzma libbz2-dev liblzma-dev
+### Quickstart using `pip`
 
-# python, pip
-sudo apt install python3 python3-pip
+This project uses [uv](https://github.com/astral-sh/uv) for managing dependencies.
+If you just want to try the bot and skip all the development setup,
+you can use `pip` instead of `uv` (requires Python >= 3.11):
 
-# pyenv
-curl https://pyenv.run | bash
-pyenv install 3.11.4
+```shell
+# create and activate virtual environment (optional, but recommended)
+python -m venv .venv
+. .venv/bin/activate  # Windows: '.venv/Scripts/activate'
 
-echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc
-echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc
-echo 'eval "$(pyenv init -)"' >> ~/.bashrc
-. ~/.bashrc
+# install this package
+pip install .
 
-# pipenv
-python3 -m pip install pipenv
-echo 'alias pipenv="python3 -m pipenv"' >> ~/.bashrc
-. ~/.bashrc
+# run the bot
+run-bot
 ```
 
-### Using pipenv
-This is a summary of useful pipenv commands.
-Please refer to the [pipenv documentation](https://pipenv.pypa.io/en/latest/) for details.
+### Development setup using `uv`
 
-```shell
-# generate venv from Pipfile.lock
-pipenv install
-pipenv install --dev  # include dev dependencies
+Install `uv` as documented [here](https://docs.astral.sh/uv/getting-started/installation/), then
+create/update virtual environment with all dependencies according to [`uv.lock`](./uv.lock) 
+with `uv sync --dev`.
 
-# activate pipenv-generated venv
-pipenv shell
+If required, `uv` will download the required Python version, as specified in 
+[`.python-version`](./.python-version).
 
-# reset all packages to versions pinned in Pipfile.lock
-pipenv sync
-pipenv sync --dev  # include dev dependencies
+### Using `uv`
 
-# install package and update all other packages
-pipenv install package
-pipenv install --dev package  # install as dev dependency
+This is a summary of useful `uv` commands.
+Please refer to the [uv documentation](https://docs.astral.sh/uv) or `uv help` for details.
 
-# upgrade only specific package without updating all other packages
-pipenv upgrade package
-pipenv upgrade --dev package  # upgrade as dev dependency
+```shell
+# generate .venv/ from uv.lock
+uv sync
+uv sync --dev  # include dev dependencies
 
-# remove package and update all other packages
-pipenv uninstall package
+# activate uv-generated venv
+. .venv/bin/activate  # Windows: '.venv/Scripts/activate'
 
-# remove only specific packages without updating all other package
-# [impossible]
-```
+# reset all packages to versions pinned in uv.lock
+uv sync
+uv sync --dev  # include dev dependencies
 
-### Clone repo, install dependencies, run tests
-```shell
-# clone repo, install dependencies
-git clone https://github.com/EuroPython/discord europython-discord/
-cd europython-discord
-
-# install dependencies
-pipenv install --dev
-
-# run linting and tests
-pipenv run black --check .
-pipenv run isort --check .
-pipenv run flake8 .
-pipenv run pytest .
+# add package
+uv add package
+uv add --dev package  # install as dev dependency
+
+# upgrade packages
+uv lock --upgrade
+
+# remove package
+uv remove package
 ```
 
+### Development tools
+
+* Format code: `uv run --dev black .`
+* Check code format: `uv run --dev black --check .`
+* Sort imports: `uv run --dev isort .`
+* Check import order: `uv run --dev isort --check .`
+* Check code style: `uv run --dev flake8 .`
+* Run tests: `uv run --dev pytest .`
+
 ### Configuration
+
 Create `config.local.toml` file in EuroPythonBot directory, it would be used instead of `config.toml` if exists.
 
 Add `.secrets` file to the root of the repository with the following content:
+
 ```shell
 DISCORD_BOT_TOKEN=<EuroPythonTestBotToken_from_1Password>
 PRETIX_TOKEN=<PretixStagingToken_from_1Password>
 ````
+
 After you have added the `.secrets` file, you can run the bot with the following command:
+
 ```shell
-pipenv run python EuroPythonBot/bot.py
+run-bot
 ```
+
 or with docker:
+
 ```shell
 docker build --tag discord_bot .
 docker run --interactive --tty --env DISCORD_BOT_TOKEN=$DISCORD_BOT_TOKEN --env PRETIX_TOKEN=$PRETIX_TOKEN discord_bot