ci: replace deptry with ty for type checking and remove deptry dependency

Author: raahulrahl

.github/actions/setup-python-env/action.yml

@@ -23,7 +23,7 @@ runs:
       with:
         version: ${{ inputs.uv-version }}
         enable-cache: "true"
-        cache-suffix: ${{ matrix.python-version }}
+        cache-suffix: ${{ inputs.python-version }}
 
     - name: Install Python dependencies
       run: uv sync --frozen

.github/workflows/main.yml

@@ -24,9 +24,6 @@ jobs:
       - name: Run pre-commit
         run: uv run pre-commit run -a --show-diff-on-failure
 
-      - name: Inspect dependencies
-        run: uv run deptry .
-
       - name: Check lock file consistency
         run: uv sync --locked
 
@@ -52,7 +49,7 @@ jobs:
         run: uv run python -m pytest tests --cov --cov-config=pyproject.toml --cov-report=xml
 
       - name: Check typing
-        run: uv run mypy
+        run: uv run ty check
 
       - name: Upload coverage reports to Codecov with GitHub Action on Python 3.11 for Ubuntu
         uses: codecov/codecov-action@v3

.gitignore

@@ -1,5 +1,5 @@
 example-project
-cookiecutter-uv-example
+create-bindu-agent-example
 
 # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
 
@@ -143,7 +143,7 @@ cython_debug/
 # Exclude .DS_Store files from being added
 .DS_Store
 example-project
-cookiecutter-uv-example
+create-bindu-agent-example
 
 # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
 

.pre-commit-config.yaml

@@ -23,4 +23,4 @@ repos:
         args: [--exit-non-zero-on-fix]
         exclude: ^\{\{cookiecutter\.project_name\}\}/
       - id: ruff-format
-        exclude: ^\{\{cookiecutter\.project_name\}\}/
+        exclude: ^\{\{cookiecutter\.project_name\}\}/

Makefile

@@ -0,0 +1,82 @@
+.PHONY: bake
+bake: ## bake without inputs and overwrite if exists.
+	@uv run cookiecutter --no-input . --overwrite-if-exists
+
+.PHONY: bake-with-inputs
+bake-with-inputs: ## bake with inputs and overwrite if exists.
+	@uv run cookiecutter . --overwrite-if-exists
+
+.PHONY: bake-and-test-deploy
+bake-and-test-deploy: ## For quick publishing to create-bindu-agent-example to test GH Actions
+	@rm -rf create-bindu-agent-example || true
+	@uv run cookiecutter --no-input . --overwrite-if-exists \
+		author="Raahul Dutta" \
+		email="dutta.raahul@gmail.com" \
+		author_github_handle=raahulmona \
+		project_name=create-bindu-agent-example
+	@cd create-bindu-agent-example; uv sync && \
+		git init -b main && \
+		git add . && \
+		uv run pre-commit install && \
+		uv run pre-commit run -a || true && \
+		git add . && \
+		uv run pre-commit run -a || true && \
+		git add . && \
+		git commit -m "init commit" && \
+		git remote add origin git@github.com:raahulmona/create-bindu-agent-example.git && \
+		git push -f origin main
+
+
+.PHONY: install
+install: ## Install the virtual environment
+	@echo "🚀 Creating virtual environment"
+	@uv sync
+
+.PHONY: check
+check: ## Run code quality tools.
+	@echo "🚀 Checking lock file consistency with 'pyproject.toml'"
+	@uv lock --locked
+	@echo "🚀 Linting code: Running pre-commit"
+	@uv run pre-commit run -a
+	@echo "🚀 Static type checking: Running ty"
+	@uv run ty check --exclude '\{\{cookiecutter.project_name\}\}/' --exclude 'create-bindu-agent-example/'
+
+.PHONY: test
+test: ## Test the code with pytest.
+	@echo "🚀 Testing code: Running pytest"
+	@uv run python -m pytest --cov --cov-config=pyproject.toml --cov-report=xml tests
+
+.PHONY: build
+build: clean-build ## Build wheel file
+	@echo "🚀 Creating wheel file"
+	@uvx --from build pyproject-build --installer uv
+
+.PHONY: clean-build
+clean-build: ## Clean build artifacts
+	@echo "🚀 Removing build artifacts"
+	@uv run python -c "import shutil; import os; shutil.rmtree('dist') if os.path.exists('dist') else None"
+
+.PHONY: publish
+publish: ## Publish a release to PyPI.
+	@echo "🚀 Publishing: Dry run."
+	@uvx --from build pyproject-build --installer uv
+	@echo "🚀 Publishing."
+	@uvx twine upload --repository-url https://upload.pypi.org/legacy/ dist/*
+
+.PHONY: build-and-publish
+build-and-publish: build publish ## Build and publish.
+
+.PHONY: docs-test
+docs-test: ## Test if documentation can be built without warnings or errors
+	@uv run mkdocs build -s
+
+.PHONY: docs
+docs: ## Build and serve the documentation
+	@uv run mkdocs serve
+
+.PHONY: help
+help:
+	@uv run python -c "import re; \
+	[[print(f'\033[36m{m[0]:<20}\033[0m {m[1]}') for m in re.findall(r'^([a-zA-Z_-]+):.*?## (.*)$$', open(makefile).read(), re.M)] for makefile in ('$(MAKEFILE_LIST)').strip().split()]"
+
+.DEFAULT_GOAL := help

cookiecutter-uv-example

@@ -0,0 +1 @@
+Subproject commit 575d8d2982ccbd36c479f51c3d88c21ace4430c5

cookiecutter.json

@@ -74,10 +74,6 @@
     "ty",
     "none"
   ],
-  "deptry": [
-    "y",
-    "n"
-  ],
   "storage_type": [
     "memory",
     "postgres(not implemented)"

docs/assets/light.svg

@@ -0,0 +1,42 @@
+# CI/CD with Github actions
+
+when `include_github_actions` is set to `"y"`, a `.github` directory is
+added with the following structure:
+
+    .github
+    ├── workflows
+    ├─── run-checks
+    │    └── action.yml
+    ├─── setup-python-env
+    │    └── action.yml
+    ├── on-merge-to-main.yml
+    ├── on-pull-request.yml
+    └── on-release-main.yml
+
+`on-merge-to-main.yml` and `on-pull-request.yml` are identical except
+for their trigger conditions; the first is run whenever a new commit is
+made to `main` (which should
+[only](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)
+happen through merge requests, hence the name), and the latter is run
+whenever a pull request is opened or updated. They call the `action.yml`
+files to set-up the environment, run the tests, and check the code
+formatting.
+
+`on-release-main.yml` does all of the former whenever a new release is
+made on the `main` branch. In addition, `on-release-main.yml` also
+publishes the project to PyPI if `publish_to_pypi` is set to
+`"y"`, and it builds and deploys the documentation
+if `mkdocs` is set to `"y"`. To learn more about these features,
+see [Publishing to PyPI](./publishing.md) and [Documentation with MkDocs](./mkdocs.md)
+
+Additionally, all workflows check for compatibility with multiple Python
+versions if `tox` is set to `"y"`.
+
+## How to trigger a release?
+
+To trigger a new release, navigate to your repository on GitHub, click `Releases` on the right, and then select `Draft
+a new release`. If you fail to find the button, you could also directly visit
+`https://github.com/<username>/<repository-name>/releases/new`.
+
+Give your release a title, and add a new tag in the form `*.*.*` where the
+`*`'s are alphanumeric. To finish, press `Publish release`.

docs/features/cicd.md

@@ -0,0 +1,30 @@
+# Test coverage with codecov
+
+If `codecov` is set to `"y"`, `pytest-cov` is added as a development dependency,
+and `make test` will run the tests and output a coverage report as `coverage.xml`.
+If `include_github_actions` is set to `"y"`, coverage tests with [codecov](https://about.codecov.io/) are added to the CI/CD pipeline. To enable this, sign up at [codecov.io](https://about.codecov.io/) with your GitHub account.
+If codecov is configured to require token authentication for the upload, then follow the [instructions](https://docs.codecov.com/docs/codecov-tokens#types-of-tokens) for token generation and how to add it on your GitHub repository.
+Additionally, a `codecov.yaml` file is created, with the following defaults:
+
+```yaml
+# Badge color changes from red to green between 70% and 100%
+# PR pipeline fails if codecov falls with 1%
+
+coverage:
+  range: 70..100
+  round: down
+  precision: 1
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+
+# Ignoring Paths
+# --------------
+# which folders/files to ignore
+ignore:
+  - "foo/bar.py"
+```
+
+If `codecov` is set to `"n"`, `pytest-cov` is not added to the development dependencies and the github actions won't produce a coverage report.