ci: set up automatic versioning.

readme: updated.

Author: pabloitu

.github/workflows/publish-pypi.yml

@@ -23,16 +23,16 @@ jobs:
           create-args: >-
             python=3.10
 
-      - name: Install py-build
+      - name: Install py-build and setuptools-scm
         run: |
-          python3 -m pip install --upgrade build
+          micromamba run -n floatcsep python3 -m pip install --upgrade build setuptools-scm
 
       - name: Build
         run: |
-          python3 -m build --sdist --wheel --outdir dist/
+          micromamba run -n floatcsep python3 -m build --sdist --wheel --outdir dist/
 
       - name: Publish Package
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@v1.9.0
         with:
           user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,3 +1,3 @@
 .idea/
 __pycache__
-
+version

README.md

@@ -6,18 +6,15 @@
 
 <p left>
 
-<a href='https://floatcsep.readthedocs.io/en/latest/?badge=latest'>
-    <img src='https://readthedocs.org/projects/floatcsep/badge/?version=latest' alt='Documentation Status' />
-</a>
-<a href='https://github.com/cseptesting/floatcsep/actions/workflows/build-test.yml'>
-    <img src='https://github.com/cseptesting/floatcsep/actions/workflows/build-test.yml/badge.svg' alt='Documentation Status' />
-</a>
-<img alt="PyPI" src="https://img.shields.io/pypi/v/floatcsep">
-
-<a href="https://codecov.io/gh/cseptesting/floatcsep" > 
- <img src="https://codecov.io/gh/cseptesting/floatcsep/branch/main/graph/badge.svg?token=LI4RSDOKA1"/> 
- </a>
-<a href="https://doi.org/10.5281/zenodo.7953816"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.7953816.svg" alt="DOI"></a>
+[![Documentation Status](https://readthedocs.org/projects/floatcsep/badge/?version=latest)](https://floatcsep.readthedocs.io/en/latest/?badge=latest)
+[![Build Status](https://github.com/cseptesting/floatcsep/actions/workflows/build-test.yml/badge.svg)](https://github.com/cseptesting/floatcsep/actions/workflows/build-test.yml)
+[![PyPI Version](https://img.shields.io/pypi/v/floatcsep)](https://pypi.org/project/floatcsep/)
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/floatcsep)](https://anaconda.org/conda-forge/floatcsep)
+[![Python Versions](https://img.shields.io/pypi/pyversions/floatcsep)](https://pypi.org/project/floatcsep/)
+[![Code Coverage](https://codecov.io/gh/cseptesting/floatcsep/branch/main/graph/badge.svg?token=LI4RSDOKA1)](https://codecov.io/gh/cseptesting/floatcsep)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7953816.svg)](https://doi.org/10.5281/zenodo.7953816)
+
+
 </p>
 
 * Set up a testing **experiment** for your earthquake forecasts using authoritative data sources

docs/conf.py

@@ -5,6 +5,7 @@
 import os
 import sys
 from sphinx_gallery.sorting import FileNameSortKey
+from importlib.metadata import version as get_version
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -16,7 +17,8 @@
 project = "floatCSEP"
 copyright = "2024, Pablo Iturrieta"
 author = "Pablo Iturrieta"
-release = "v0.2.0"
+release = get_version("floatcsep")  # Automatically gets the version from setuptools_scm
+
 
 # -- General configuration ---------------------------------------------------
 
@@ -25,8 +27,8 @@
     "sphinx.ext.todo",
     "sphinx.ext.autosummary",
     "sphinx.ext.coverage",
-    'sphinx_toolbox.github',
-    'sphinx_toolbox.sidebar_links',
+    "sphinx_toolbox.github",
+    "sphinx_toolbox.sidebar_links",
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
@@ -35,10 +37,10 @@
     "sphinx_design",
 ]
 
-github_username = 'cseptesting'
-github_repository = 'floatcsep'
+github_username = "cseptesting"
+github_repository = "floatcsep"
 
-language = 'en'
+language = "en"
 autosummary_generate = False
 autoclass_content = "both"
 suppress_warnings = [
@@ -82,30 +84,21 @@
 
 html_context = {
     "github_links": [
+        ("Getting help", "https://github.com/cseptesting/floatcsep/issues"),
         (
-            'Getting help',
-            "https://github.com/cseptesting/floatcsep/issues"
-        ),
-        (
-            'Contributing',
-            "https://github.com/cseptesting/floatcsep/blob/master/CONTRIBUTING.md"
-        ),
-        (
-            'Code of Conduct',
-            "https://github.com/cseptesting/floatcsep/blob/master/CODE_OF_CONDUCT.md"
-        ),
-        (
-            'License',
-            "https://github.com/cseptesting/floatcsep/blob/master/LICENSE"
+            "Contributing",
+            "https://github.com/cseptesting/floatcsep/blob/master/CONTRIBUTING.md",
         ),
         (
-            'Source Code',
-            "https://github.com/cseptesting/floatcsep"
+            "Code of Conduct",
+            "https://github.com/cseptesting/floatcsep/blob/master/CODE_OF_CONDUCT.md",
         ),
+        ("License", "https://github.com/cseptesting/floatcsep/blob/master/LICENSE"),
+        ("Source Code", "https://github.com/cseptesting/floatcsep"),
     ],
 }
 extlinks = {
-    'github_contrib': ('https://github.com/cseptesting/floatcsep/main/blob/%s', ''),
+    "github_contrib": ("https://github.com/cseptesting/floatcsep/main/blob/%s", ""),
 }
 rst_epilog = """
 .. raw:: html

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=52.0", "wheel"]
+requires = ["setuptools>=52.0", "wheel", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
@@ -16,4 +16,9 @@ target-version = ["py39", "py310", "py311"]
 
 [tool.flake8]
 ignore = ["E203", "W503", "F401"]
-max-line-length = 96
+max-line-length = 96
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "no-local-version"
+fallback_version = "0.2.0"

requirements_dev.txt

@@ -21,6 +21,7 @@ pyyaml
 requests
 scipy
 seaborn
+setuptools-scm
 shapely
 sphinx
 sphinx-autoapi

setup.cfg

@@ -6,7 +6,7 @@ long_description_content_type = text/markdown
 author = Pablo Iturrieta
 author_email = pciturri@gfz-potsdam.de
 license = BSD 3-Clause License
-version = 0.1.4
+version = attr: setuptools_scm.get_version
 platforms = unix, linux, osx, win32
 classifiers =
     Programming Language :: Python :: 3
@@ -69,6 +69,7 @@ dev =
     requests
     scipy
     seaborn
+    setuptools-scm
     shapely
     sphinx
     sphinx-autoapi

setup.py

@@ -1,4 +1,8 @@
 from setuptools import setup
 
 if __name__ == "__main__":
-    setup()
+    setup(
+        name="floatcsep",
+        use_scm_version=True,
+        setup_requires=["setuptools-scm"],
+    )