Auto push to PyPi on edit

Author: tanner-andrulis

.github/workflows/publish.yaml

@@ -0,0 +1,36 @@
+name: Upload Python Package to PyPI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  release:
+    types: [created]
+
+jobs:
+  pypi-publish:
+    name: Publish package to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hwcomponents-adc
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Fetch all history and tags for setuptools-scm
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: |
+          python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.md

@@ -2,19 +2,21 @@
 HWComponents-ADC models the area and energy of Analog-Digital Converters (ADCs) for use
 in analog & mixed-signal accelerator designs.
 
+These models are for use with the HWComponents package, found at
+https://accelergy-project.github.io/hwcomponents/.
+
 Models are based on statistical analysis of published ADC performance data in Boris
 Murmann's ADC Performance Survey [1]. The energy model is based on the observation that
 the maximum efficiency of an ADC is bounded by the sampling rate and the resolution [1],
 and the area model is based on regression analysis. Estimations are optimistic; they
 answer the question "what is the best possible ADC design for the given parameters?".
 
 ## Installation
-Clone the repository and install with pip:
+
+Install from PyPI:
 
 ```bash
-git clone https://github.com/Accelergy-Project/hwcomponents-adc.git
-cd hwcomponents-adc
-pip install .
+pip install hwcomponents-adc
 
 # Check that the installation is successful
 hwc --list | grep ADC
@@ -82,12 +84,12 @@ If you use this model in your work, please cite the following:
 
 ```bibtex
 @misc{andrulis2024modelinganalogdigitalconverterenergyarea,
-      title={Modeling Analog-Digital-Converter Energy and Area for Compute-In-Memory Accelerator Design}, 
+      title={Modeling Analog-Digital-Converter Energy and Area for Compute-In-Memory Accelerator Design},
       author={Tanner Andrulis and Ruicong Chen and Hae-Seung Lee and Joel S. Emer and Vivienne Sze},
       year={2024},
       eprint={2404.06553},
       archivePrefix={arXiv},
       primaryClass={cs.AR},
-      url={https://arxiv.org/abs/2404.06553}, 
+      url={https://arxiv.org/abs/2404.06553},
 }
 ```

pyproject.toml

@@ -1,25 +1,25 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm>=6.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "hwcomponents-adc"
-version = "0.1"
+dynamic = ["version"]
 description = "A package for estimating the energy and area of Analog-Digital Converters"
 readme = "README.md"
 requires-python = ">=3.12"
-license = {text = "MIT"}
+license = "MIT"
 authors = [
     {name = "Tanner Andrulis", email = "Andrulis@mit.edu"}
 ]
 keywords = ["accelerator", "hardware", "energy", "estimation", "analog", "adc"]
 classifiers = [
     "Development Status :: 3 - Alpha",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
 ]
 dependencies = [
+    "hwcomponents",
     "PyYAML",
     "numpy",
     "pandas",
@@ -28,9 +28,14 @@ dependencies = [
 [tool.setuptools]
 packages = {find = {}}
 include-package-data = true
-py-modules = ["hwcomponents_adc"]
 
 [tool.setuptools.package-data]
 hwcomponents_adc = [
     "adc_data/model.yaml",
 ]
+
+[tool.setuptools_scm]
+write_to = "hwcomponents_adc/_version.py"
+fallback_version = "1.0.0"
+version_scheme = "setup_scm_version:post_version"
+local_scheme = "setup_scm_version:no_local"

setup_scm_version.py

@@ -0,0 +1,18 @@
+"""Version scheme for setuptools-scm - creates post-release versions."""
+from setuptools_scm.version import guess_next_version
+
+
+def post_version(version):
+    """Create post-release versions instead of dev versions."""
+    if version.exact:
+        return version.format_with("{tag}").lstrip('v')
+
+    base = str(version.tag).lstrip('v') if version.tag else (guess_next_version(version) or "1.0.0")
+    distance = version.distance or 0
+
+    return f"{base}.post{distance}" if distance > 0 else base
+
+
+def no_local(version):
+    """No local version identifier."""
+    return ""