ci: Publish python package to pypi

.github/workflows/python-wheels.yml

@@ -0,0 +1,59 @@
+name: Build and publish python wheels
+
+on:
+ workflow_dispatch:
+ push:
+ branches:
+ - main
+ tags:
+ - '*'
+
+jobs:
+ build-publish:
+ name: Build and publish wheels
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ package:
+ - 'quantinuum-hugr-py'
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Run sccache-cache
+ uses: mozilla-actions/[email protected]
+ - name: Install poetry
+ run: pipx install poetry
+ - name: Set up Python '3.10'
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.10'
+ cache: "poetry"
+
+ - name: Build sdist and wheels
+ run: |
+ cd ${{ matrix.package }}
+ poetry build -o ../dist
+
+ - name: Upload the built packages as artifacts
+ uses: actions/upload-artifact@v4
+ with:
+ name: build-${{ matrix.package }}-sdist
+ path: |
+ dist/*.tar.gz
+ dist/*.whl
+
+ - name: Publish to test instance of PyPI
+ if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'push' && github.ref_type == 'branch' ) }}
+ run: |
+ cd ${{ matrix.package }}
+ poetry config repositories.test-pypi https://test.pypi.org/legacy/
+ poetry config pypi-token.test-pypi ${{ secrets.PYPI_TEST_PUBLISH }}
+ poetry publish -r test-pypi --dist-dir ../dist --skip-existing
+
+ - name: Publish to PyPI
+ if: ${{ github.event_name == 'push' && github.ref_type == 'tag' && startsWith(github.ref, format('refs/tags/{}-v', matrix.package)) }}
+ run: |
+ cd ${{ matrix.package }}
+ poetry config repositories.test-pypi https://test.pypi.org/legacy/
+ poetry config pypi-token.test-pypi ${{ secrets.PYPI_PUBLISH }}
+ poetry publish -r test-pypi --dist-dir ../dist --skip-existing

pyproject.toml

@@ -2,10 +2,9 @@
 description = "Namespace for the python packages in the HUGR repository. See the individual packages for more information."
 name = "hugr-project"
 version = "0.0.0"
-authors = []
+authors = ["TKET development team <[email protected]>"]
 readme = "README.md"
-packages = []
-
+packages = [{ include = "quantunuum_hugr", from = "quantunuum-hugr-py" }]
 package-mode = false
 
 [tool.poetry.group.main.dependencies]

quantinuum-hugr-py/README.md

@@ -22,15 +22,13 @@ The HUGR specification is [here](https://github.com/CQCL/hugr/blob/main/specific
 
 ## Installation
 
-TODO
-
-The package name is `quantinuum_hugr`, but it hasn't been published yet.
-The current experimental version can be installed from the source code:
-
+The package name is `quantinuum_hugr`, it can be installed from PyPI:
 ```bash
-pip install "quantinuum_hugr@git+https://github.com/CQCL/hugr.git@main#subdirectory=quantinuum-hugr-py"
+pip install quantinuum_hugr"
 ```
 
+The current releases are in alpha stage, and the API is subject to change.
+
 ## Usage
 
 TODO

quantinuum-hugr-py/pyproject.toml

@@ -1,11 +1,23 @@
 [tool.poetry]
+classifiers = [
+ "Environment :: Console",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
+ "License :: OSI Approved :: Apache Software License",
+ "Operating System :: MacOS :: MacOS X",
+ "Operating System :: POSIX :: Linux",
+ "Operating System :: Microsoft :: Windows",
+ "Intended Audience :: Developers",
+ "Intended Audience :: Science/Research",
+ "Topic :: Scientific/Engineering",
+]
 name = "quantinuum_hugr"
-version = "0.0.0"
+version = "0.1.0a1"
 description = "Quantinuum's common representation for quantum programs"
-classifiers = [] # TODO
-keywords = [] # TODO
-authors = [] # TODO
-maintainers = [] # TODO
+#keywords = []
+authors = ["TKET development team <[email protected]>"]
+maintainers = ["TKET development team <[email protected]>"]
 license = "Apache-2.0"
 readme = "README.md"
 homepage = "https://github.com/CQCL/hugr"