Merge pull request #38 from derb12/update_internals

MAINT: Add dynamic versioning and dependabot for GitHub actions versioning

Author: derb12

.github/dependabot.yml

@@ -0,0 +1,9 @@
+# See the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # Only update GitHub actions dependencies
+    directory: "/" # Only update the worflow files
+    schedule:
+      interval: "monthly"

.github/workflows/python-test-latest.yml

@@ -23,6 +23,11 @@ on:
     - 'tests/**'
     - '.github/workflows/**'
 
+# cancel current jobs if a new job is started
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test-nightly:
 
@@ -34,10 +39,10 @@ jobs:
         python-version: ['3.13']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -47,6 +52,7 @@ jobs:
         python -m pip install pytest
         python -m pip install -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple numpy
         python -m pip install -i https://pypi.anaconda.org/scientific-python-nightly-wheels/simple scipy
+        python -m pip install .
 
     - name: Test with required dependencies
       # use -Werror so that any warnings will show up as errors -> want to be as stringent

.github/workflows/python-test.yml

@@ -23,6 +23,11 @@ on:
     - 'tests/**'
     - '.github/workflows/**'
 
+# cancel current jobs if a new job is started
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   test:
 
@@ -34,12 +39,16 @@ jobs:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.13t']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      # fetch-depth: '0' is needed to fetch tags for hatch-vcs (and thus setuptools-scm)
+      # to generate the version correctly; only really needed for jobs that would build and
+      # upload to pypi, so ignore it since fetching the entire git history can take much longer
+      # than the default of fetching just the last commit
+      #with:
+        #fetch-depth: '0'
 
     - name: Set up Python
-      # Switch back to actions/setup-python@v5 once they support free-threaded python;
-      # see revelant PR: https://github.com/actions/setup-python/pull/973
-      uses: Quansight-Labs/setup-python@v5
+      uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -71,10 +80,10 @@ jobs:
         python-version: ['3.9']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -83,7 +92,7 @@ jobs:
       # for minimum supported versions
       run: |
         python -m pip install --upgrade pip
-        python -m pip install "numpy==1.20.*" "scipy==1.6.*" pytest
+        python -m pip install . "numpy==1.20.*" "scipy==1.6.*" pytest
 
     - name: Test with minimum required dependencies
       run: pytest .
@@ -103,10 +112,10 @@ jobs:
         python-version: ['3.13']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
       with:
         python-version: ${{ matrix.python-version }}
 

.gitignore

@@ -21,6 +21,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

docs/conf.py

@@ -70,10 +70,11 @@
 # for |version| and |release|, also used in various other places throughout
 # the built documents.
 #
-# The short X.Y version.
-version = '1.2.0'
+from importlib.metadata import version as _get_version
 # The full version, including alpha/beta/rc tags.
-release = version
+release = _get_version('pybaselines')
+# The short X.Y version.
+version = '.'.join(release.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pybaselines/__init__.py

@@ -11,8 +11,11 @@
 
 """
 
-__version__ = '1.2.0'
-
+try:
+    from ._version import __version__
+except ImportError:
+    # in case of local use without installing first
+    __version__ = '1.2.0.post1.dev0'
 
 # import utils first since it is imported by other modules; likewise, import
 # optimizers and api last since they import the other modules

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 # hatchling v1.27 was first version to use default metadata version 2.4, allowing project.license
 # and project.license-files fields following PEP-639
-requires = ["hatchling>=1.27"]
+requires = ["hatchling>=1.27", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build]
@@ -13,10 +13,20 @@ exclude = [
   "/tools",
 ]
 
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "1.2.0.post1.dev0"
+
+[tool.hatch.version.raw-options]
+version_scheme = "no-guess-dev"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "pybaselines/_version.py"
+
 
 [project]
 name = "pybaselines"
-version = "1.2.0"
+dynamic = ["version"]
 authors = [
     {name = "Donald Erb", email = "donnie.erb@gmail.com"},
 ]
@@ -107,7 +117,7 @@ src_paths = ["pybaselines", "tests"]
 known_local_folder = ["example_helpers"]
 
 [tool.ruff]
-exclude = ["docs/*"]
+exclude = ["docs/conf.py"]
 line-length = 100
 fix = false
 output-format = "full"
@@ -142,7 +152,7 @@ convention = "numpy"
     "D205",  # D205: 1 blank line required between summary line and description
 
 ]
-"examples/*" = [
+"docs/examples/*" = [
     "B007",  # B007: Loop control variable `name` not used within loop body; want to be explicit in examples
     "D205",  # D205: 1 blank line required between summary line and description
     "D400",  # D400: first line should end with a period
@@ -165,14 +175,14 @@ search = "version = \"{current_version}\""
 replace = "version = \"{new_version}\""
 
 [[tool.bumpversion.files]]
-filename = "pybaselines/__init__.py"
-search = "__version__ = '{current_version}'"
-replace = "__version__ = '{new_version}'"
+filename = "pyproject.toml"
+search = "fallback-version = \"{current_version}.post1.dev0\""
+replace = "fallback-version = \"{new_version}.post1.dev0\""
 
 [[tool.bumpversion.files]]
-filename = "docs/conf.py"
-search = "version = '{current_version}'"
-replace = "version = '{new_version}'"
+filename = "pybaselines/__init__.py"
+search = "__version__ = '{current_version}.post1.dev0'"
+replace = "__version__ = '{new_version}.post1.dev0'"
 
 [[tool.bumpversion.files]]
 filename = "CITATION.cff"