Badges

.github/workflows/cicd.yaml

@@ -18,7 +18,7 @@ jobs:
 
   # When a release is created on github (using the vX.Y.Z tag formatting), publish the package to PyPI.
   publish:
-    # if: startsWith(github.ref, 'refs/tags/v')
+    if: startsWith(github.ref, 'refs/tags/v')
     runs-on: ubuntu-22.04
     needs:
       - lint

Makefile

@@ -29,6 +29,9 @@ test: install  ## Run the unit tests
 build:  ## Build the package (e.g., for publishing to PyPI)
 	poetry build
 
+clean:  ## Clean up build artifacts
+	rm -rf dist
+
 # Adjust which paths we lint
 LINT_PATHS="."
 

README.md

@@ -1,3 +1,12 @@
-# python-template
+# mjv-template
+
+[![cicd](https://github.com/mjvogelsong/python-template/actions/workflows/cicd.yaml/badge.svg)](./.github/workflows/cicd.yaml)
+[![pypi](https://img.shields.io/pypi/v/mjv-template.svg)](https://pypi.org/project/mjv-template/)
+[![python](https://img.shields.io/pypi/pyversions/mjv-template.svg)](https://pypi.org/project/mjv-template/)
+[![license](https://img.shields.io/pypi/l/mjv-template.svg)](https://pypi.org/project/mjv-template/)
+
+[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+[![pydantic](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/pydantic/main/docs/badge/v2.json)](https://pydantic.dev)
 
 A template for python projects.