CI: Add Packaging (#2)

Co-authored-by: github-actions <[email protected]>

Author: ric-evans

.github/workflows/wipac-cicd.yaml

@@ -9,6 +9,26 @@ on:
 
 jobs:
 
+  ###########################################################################
+  # PACKAGING
+  ###########################################################################
+
+  py-setup:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+      - uses: WIPACrepo/[email protected]
+        with:
+          python_min: 3.9
+          pypi_name: icecube-simprod-histograms
+          author: IceCube
+          author_email: [email protected]
+          keywords: |
+            "histogram sampling" simulation statistics
+
+
   ###########################################################################
   # LINTERS
   ###########################################################################
@@ -90,7 +110,7 @@ jobs:
         with:
           python-version: ${{ matrix.py3 }}
       - run: |
-          pip install -r requirements-tests.txt
+          pip install .[tests]
       - name: Run unit tests
         run: |
           pytest -vvv tests/unit/
@@ -101,14 +121,25 @@ jobs:
 
   release:
     if: github.ref == 'refs/heads/main'
-    needs: [ flake8, mypy, code-format, unit-tests ]
+    needs: [ py-setup, flake8, mypy, code-format, unit-tests ]
     runs-on: ubuntu-latest
+    concurrency: release  # prevent any possible race conditions
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Python Semantic Release
-        uses: python-semantic-release/[email protected]
+      # Python-Package Version Bump
+      - uses: python-semantic-release/[email protected]
+        id: psr-psr
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      # PyPI Release
+      - uses: pypa/[email protected]
+        if: steps.psr-psr.outputs.released == 'true'
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}
+      # GitHub Release
+      - uses: python-semantic-release/[email protected]
+        if: steps.psr-psr.outputs.released == 'true'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,2 +1,5 @@
+<!--- Top of README Badges (automated) --->
+[![PyPI](https://img.shields.io/pypi/v/icecube-simprod-histograms)](https://pypi.org/project/icecube-simprod-histograms/) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/icecube/simprod-histogram?include_prereleases)](https://github.com/icecube/simprod-histogram/) [![Versions](https://img.shields.io/pypi/pyversions/icecube-simprod-histograms.svg)](https://pypi.org/project/icecube-simprod-histograms) [![PyPI - License](https://img.shields.io/pypi/l/icecube-simprod-histograms)](https://github.com/icecube/simprod-histogram/blob/main/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/icecube/simprod-histogram)](https://github.com/icecube/simprod-histogram/issues?q=is%3Aissue+sort%3Aupdated-desc+is%3Aopen) [![GitHub pull requests](https://img.shields.io/github/issues-pr/icecube/simprod-histogram)](https://github.com/icecube/simprod-histogram/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aopen)
+<!--- End of README Badges (automated) --->
 # simprod-histogram
 Utilities for working with histograms created for simprod

pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+version = "0.0.0"
+dependencies = ["h5py"]
+name = "icecube-simprod-histograms"
+description = "Utilities for working with histograms created for simprod"
+readme = "README.md"
+keywords = ["histogram sampling", "simulation", "statistics"]
+classifiers = ["Development Status :: 3 - Alpha", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13"]
+requires-python = ">=3.9, <3.14"
+
+[[project.authors]]
+name = "IceCube"
+email = "[email protected]"
+
+[project.license]
+file = "LICENSE"
+
+[project.optional-dependencies]
+tests = ["h5py", "pytest", "matplotlib"]
+mypy = ["h5py", "pytest", "matplotlib"]
+display = ["h5py", "matplotlib"]
+
+[project.urls]
+Homepage = "https://pypi.org/project/icecube-simprod-histograms/"
+Tracker = "https://github.com/icecube/simprod-histogram/issues"
+Source = "https://github.com/icecube/simprod-histogram"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+version_variables = []
+commit_parser = "emoji"
+build_command = "pip install build && python -m build"
+
+[tool.semantic_release.commit_parser_options]
+major_tags = ["[major]"]
+minor_tags = ["[minor]", "[feature]"]
+patch_tags = ["[patch]", "[fix]", " ", "!", "#", "$", "%", "&", "'", "(", ")", "*", "+", "-", ".", "/", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", ":", ";", "<", "=", ">", "?", "@", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "[", "]", "^", "_", "`", "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z", "{", "|", "}", "~"]
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
+[tool.setuptools.packages.find]
+namespaces = false
+exclude = ["test", "tests", "doc", "docs", "resource", "resources", "example", "examples"]

requirements-display.txt

@@ -0,0 +1,3 @@
+from setuptools import setup  # type: ignore[import]
+
+setup()