Port setup.py to pyproject.toml, switch to uv

https://gistpreview.github.io/?354b66dab89c47d7e190b424665ca944/index.html

Author: simonw

.github/workflows/publish.yml

@@ -34,7 +34,7 @@ jobs:
         sudo apt-get -y install "postgresql-$POSTGRESQL_VERSION"
     - name: Install dependencies
       run: |
-        pip install -e '.[test]'
+        pip install -e . --group dev
     - name: Run tests
       env:
         POSTGRESQL_VERSION: ${{ matrix.postgresql-version }}

.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
         sudo apt-get -y install "postgresql-$POSTGRESQL_VERSION"
     - name: Install dependencies
       run: |
-        pip install -e '.[test]'
+        pip install -e . --group dev
     - name: Run tests
       env:
         POSTGRESQL_VERSION: ${{ matrix.postgresql-version }}

conftest.py

@@ -4,8 +4,17 @@
 from django_sql_dashboard.models import Dashboard
 
 
+def pytest_collection_modifyitems(items):
+    """Add django_db marker with databases to tests that need database access."""
+    for item in items:
+        fixturenames = getattr(item, "fixturenames", ())
+        # Tests using client fixtures or dashboard_db need both databases
+        if any(f in fixturenames for f in ("admin_client", "client", "dashboard_db")):
+            item.add_marker(pytest.mark.django_db(databases=["default", "dashboard"]))
+
+
 @pytest.fixture
-def dashboard_db(settings, db):
+def dashboard_db(settings):
     settings.DATABASES["dashboard"]["OPTIONS"] = {
         "options": "-c default_transaction_read_only=on -c statement_timeout=100"
     }

docs/contributing.md

@@ -1,35 +1,22 @@
 # Contributing
 
-To contribute to this library, first checkout the code. Then create a new virtual environment:
+To contribute to this library, first checkout the code. Use [uv](https://github.com/astral-sh/uv) to run the tests:
 
     cd django-sql-dashboard
-    python -m venv venv
-    source venv/bin/activate
-
-Or if you are using `pipenv`:
-
-    pipenv shell
-
-Now install the dependencies and tests:
-
-    pip install -e '.[test]'
-
-## Running the tests
-
-To run the tests:
-
-    pytest
+    uv run pytest
 
 ## Generating new migrations
 
 To generate migrations for model changes:
 
     cd test_project
-    ./manage.py makemigrations
+    uv run ./manage.py makemigrations
 
 ## Code style
 
-This library uses [Black](https://github.com/psf/black) for code formatting. The correct version of Black will be installed by `pip install -e '.[test]'` - you can run `black .` in the root directory to apply those formatting rules.
+This library uses [Black](https://github.com/psf/black) for code formatting. You can run it like this:
+
+    uv run black .
 
 ## Documentation
 
@@ -38,8 +25,7 @@ Documentation for this project uses [MyST](https://myst-parser.readthedocs.io/)
 To build the documentation locally, run the following:
 
     cd docs
-    pip install -r requirements.txt
-    make livehtml
+    uv run --with-requirements requirements.txt make livehtml
 
 This will start a live preview server, using [sphinx-autobuild](https://pypi.org/project/sphinx-autobuild/).
 

pyproject.toml

@@ -1,3 +1,51 @@
+[project]
+name = "django-sql-dashboard"
+version = "1.2"
+description = "Django app for building dashboards using raw SQL queries"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [
+    { name = "Simon Willison" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "Django>=4.2",
+    "markdown",
+    "bleach",
+]
+
+[project.urls]
+Documentation = "https://django-sql-dashboard.datasette.io/"
+Issues = "https://github.com/simonw/django-sql-dashboard/issues"
+CI = "https://github.com/simonw/django-sql-dashboard/actions"
+Changelog = "https://github.com/simonw/django-sql-dashboard/releases"
+Homepage = "https://github.com/simonw/django-sql-dashboard"
+
+[dependency-groups]
+dev = [
+    "black>=22.3.0",
+    "psycopg2",
+    "pytest",
+    "pytest-django>=4.11.1",
+    "pytest-pythonpath",
+    "dj-database-url",
+    "testing.postgresql",
+    "beautifulsoup4",
+    "html5lib",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["django_sql_dashboard"]
+
 [tool.isort]
 profile = "black"
 multi_line_output = 3
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "config.settings"
+pythonpath = ["test_project", "pytest_plugins"]
+addopts = "-p pytest_use_postgresql"