feat: setup uv (#24)

gadomski · web-flow · commit 77f8c4d69229 · 2025-01-02T06:08:43.000-07:00
- Closes #19
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,12 +7,15 @@ on:
   pull_request:
 
 jobs:
-  lint:
-    name: Lint
+  lint-and-test:
+    name: Lint and test
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
       - name: Install
-        run: scripts/install
+        run: scripts/install --dev
       - name: Lint
         run: scripts/lint
+      - name: Test
+        run: scripts/test
diff --git a/.gitignore b/.gitignore
@@ -1 +1,173 @@
 node_modules/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/README.md b/README.md
@@ -4,20 +4,43 @@
 
 We're building a service to search [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet) with a STAC API [query](https://api.stacspec.org/v1.0.0/item-search/).
 
-## Developing
+## Usage
 
-Get [yarn](https://yarnpkg.com/getting-started/install), then:
+Get [uv](https://docs.astral.sh/uv/getting-started/installation/)
 
 ```shell
 git clone git@github.com:developmentseed/labs-375-stac-geoparquet-backend.git
 cd labs-375-stac-geoparquet-backend
 scripts/install
 ```
 
-To lint:
+Then:
+
+```shell
+scripts/dev
+```
+
+This will start the server on <http://127.0.0.1:8000/>.
+
+## Developing
+
+Get [yarn](https://yarnpkg.com/getting-started/install), then:
+
+```shell
+scripts/install --dev
+```
+
+Run the test suite:
+
+```shell
+scripts/test
+```
+
+To format or lint:
 
 ```shell
-scripts/lint
+scripts/format # Fixes things
+scripts/lint   # Doesn't fix things
 ```
 
 ## Core assumptions
diff --git a/main.py b/main.py
@@ -0,0 +1,3 @@
+import tistac.app
+
+app = tistac.app.build()
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,27 @@
+[project]
+name = "tistac"
+version = "0.1.0"
+description = "A small multi-backend STAC API server built on FastAPI."
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi[standard]>=0.115.6",
+    "pydantic>=2.10.4",
+]
+
+[dependency-groups]
+dev = ["mypy>=1.14.1", "pytest>=8.3.4", "pytest-asyncio>=0.25.1", "ruff>=0.8.5"]
+
+[tool.mypy]
+strict = true
+files = ["**/*.py"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
diff --git a/scripts/dev b/scripts/dev
@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+set -e
+
+uv run fastapi dev
diff --git a/scripts/format b/scripts/format
@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+set -e
+
+uv run ruff check --fix
+uv run ruff format
+yarn run markdownlint-cli2 --fix
diff --git a/scripts/install b/scripts/install
@@ -1,5 +1,9 @@
-#!/usr/bin/env sh
+#!/usr/bin/env bash
 
 set -e
 
-yarn install
+uv sync
+
+if [ "$1" == "--dev" ]; then
+    yarn install
+fi
diff --git a/scripts/lint b/scripts/lint
@@ -2,4 +2,7 @@
 
 set -e
 
+uv run ruff check
+uv run ruff format --check
+uv run mypy
 yarn run markdownlint-cli2
diff --git a/scripts/test b/scripts/test
@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+set -e
+
+uv run pytest
diff --git a/src/tistac/__init__.py b/src/tistac/__init__.py
diff --git a/src/tistac/app.py b/src/tistac/app.py
@@ -0,0 +1,17 @@
+from fastapi import FastAPI
+
+from .root import Root
+
+
+def build() -> FastAPI:
+    """Builds a new TiStac application."""
+
+    app = FastAPI()
+
+    @app.get("/")
+    async def root() -> Root:
+        """The STAC API root."""
+
+        return Root()
+
+    return app
diff --git a/src/tistac/root.py b/src/tistac/root.py
@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class Root(BaseModel):
+    """The root landing page of a STAC API."""
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -0,0 +1,9 @@
+import pytest
+from fastapi.testclient import TestClient
+
+import tistac.app
+
+
+@pytest.fixture
+def client() -> TestClient:
+    return TestClient(tistac.app.build())
diff --git a/tests/test_root.py b/tests/test_root.py
@@ -0,0 +1,6 @@
+from fastapi.testclient import TestClient
+
+
+async def test_root(client: TestClient) -> None:
+    response = client.get("/")
+    assert response.status_code == 200
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import tistac.app`
	`2`	`+`
	`3`	`+app = tistac.app.build()`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +#!/usr/bin/env sh
++
 +set -e
++
 +uv run fastapi dev