bootstrap: project boilerplate

Cobbled from a few sources, we add uv, ruff, and pyright for project
dependencies, as well as generate documentation from doc strings using
mkdocs (which is awesome!).

Author: rockwotj

.github/workflows/pyright.yaml

@@ -0,0 +1,19 @@
+name: Pyright Type Checking
+on:
+  pull_request:
+    paths:
+      - '**.py'
+  push:
+    branches: [main]
+    paths:
+      - '**.py'
+jobs:
+  pyright:
+    name: Run Pyright
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Run Pyright
+        uses: jakebailey/pyright-action@v2
+

.github/workflows/ruff.yaml

@@ -0,0 +1,17 @@
+name: Ruff
+on:
+  pull_request:
+    paths:
+      - '**.py'
+  push:
+    branches: [main]
+    paths:
+      - '**.py'
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+      - name: Run Ruff
+        uses: astral-sh/ruff-action@v3

.gitignore

@@ -1,25 +1,170 @@
-# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
 *.so
-*.dylib
 
-# Test binary, built with `go test -c`
-*.test
+# 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
 
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+# 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
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
+# 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
 
-# Go workspace file
-go.work
-go.work.sum
+# 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/
 
-# env file
+# 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
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -1,2 +1,3 @@
 # agent
+
 unreasonably good developer experience for enterprise agents

Taskfile.yaml

@@ -0,0 +1,70 @@
+version: '3'
+
+tasks:
+  sync:
+    desc: "Sync all extras and packages for the dev group"
+    cmds:
+      - uv sync --all-extras --all-packages --group dev
+
+  format:
+    aliases: [fmt]
+    desc: "Run ruff format and check with fix"
+    cmds:
+      - uv run ruff format
+      - uv run ruff check --fix
+
+  lint:
+    desc: "Run ruff check"
+    cmds:
+      - uv run ruff check
+
+  pyright:
+    desc: "Run pyright"
+    cmds:
+      - uv run pyright
+
+  tests:
+    aliases: [test]
+    desc: "Run pytest"
+    cmds:
+      - uv run pytest
+
+  coverage:
+    desc: "Run coverage tests and reports"
+    cmds:
+      - uv run coverage run -m pytest
+      - uv run coverage xml -o coverage.xml
+      - uv run coverage report -m --fail-under=95
+
+  snapshots-fix:
+    desc: "Run pytest with inline-snapshot fix"
+    cmds:
+      - uv run pytest --inline-snapshot=fix
+
+  snapshots-create:
+    desc: "Run pytest with inline-snapshot create"
+    cmds:
+      - uv run pytest --inline-snapshot=create
+
+  old-version-tests:
+    desc: "Run tests with Python 3.9"
+    env:
+      UV_PROJECT_ENVIRONMENT: ".venv_39"
+    cmds:
+      - uv run --python 3.9 -m pytest
+      - uv run --python 3.9 -m pyright .
+
+  build-docs:
+    desc: "Build documentation with mkdocs"
+    cmds:
+      - uv run mkdocs build
+
+  serve-docs:
+    desc: "Serve documentation with mkdocs"
+    cmds:
+      - uv run mkdocs serve --dev-addr 0.0.0.0:8000
+
+  deploy-docs:
+    desc: "Deploy documentation to GitHub Pages with mkdocs"
+    cmds:
+      - uv run mkdocs gh-deploy --force --verbose

docs/assets/logo.svg

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.

docs/index.md

@@ -0,0 +1,3 @@
+# Agents module
+
+::: agents