Add: dynamic versioning

Author: lwasser

.gitignore

@@ -66,3 +66,5 @@ venv.bak/
 
 # Conda-forge recipe generated by grayskull
 pyospackage/*
+# setuptools scm generates this file - it should never be committed to history
+src/pyospackage/_version.py

changelog.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-* Add: CI based pypi release workflow & dynamic versioning (@lwasser, #)
+* Add: CI based pypi release workflow & dynamic versioning (@lwasser, #32)
 * Add: readthedocs config for building documentation (@lwasser)
 * Add: Cleanup documentation structure (@lwasser)
 

pyproject.toml

@@ -6,7 +6,8 @@ build-backend = "hatchling.build"
 name = "pyospackage"
 description = "A package that adds numbers together"
 readme = "README.md"
-version = "0.1.11"
+# version = "0.1.11" # Delete this line and add the line below to tell hatch to use dynamic versioning
+dynamic = ["version"]
 requires-python = ">=3.10"
 license = "MIT"
 keywords = []
@@ -25,7 +26,7 @@ dependencies = []
 
 [project.urls]
 Homepage = "https://pypi.org/project/pyospackage/"
-Documentation = "https://github.com/pyopensci/pyospackage"
+Documentation = "https://pyospackage.readthedocs.io/en/latest/"
 Issues = "https://github.com/pyopensci/pyospackage/issues"
 Source = "https://github.com/pyopensci/pyospackage"
 
@@ -47,15 +48,15 @@ docs = [
 
 # ******* Hatch configuration here ******* #
 
+# Setup dynamic versioning (this uses setuptools_scm on the backend)
 [tool.hatch]
 version.source = "vcs"
-build.hooks.vcs.version-file = "src/pyosmeta/_version.py"
+build.hooks.vcs.version-file = "src/pyospackage/_version.py"
 
 [tool.hatch.envs.docs]
 # https://hatch.pypa.io/1.12/config/environment/overview/#features
 features = ["docs"]
 
-
 [tool.hatch.envs.docs.scripts]
 # Build your docs statically - html output
 # hatch run docs:docs-html