trying-release (#15)

* update ci

* add tox environment

* upps forgot to specify build in envlist

* add Manifest

* add contributors

Author: bananenpampe

.github/workflows/build.yml

@@ -0,0 +1,24 @@
+# This workflow builds and checks the package for release
+name: Build
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - run: pip install tox
+
+    - name: Test build integrity
+      run: tox -e build
+      env:
+        # Use the CPU only version of torch when building/running the code
+        PIP_EXTRA_INDEX_URL: https://download.pytorch.org/whl/cpu

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    tags: ["*"]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/shiftml
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - run: python -m pip install tox
+    - name: Build package
+      run: tox -e build
+    - name: Publish distribution to PyPI
+      if: startsWith(github.ref, 'refs/tags/v')
+      uses: pypa/gh-action-pypi-publish@release/v1
+    - name: Publish to GitHub release
+      if: startsWith(github.ref, 'refs/tags/v')
+      uses: softprops/action-gh-release@v2
+      with:
+        files: |
+          dist/*.tar.gz
+          dist/*.whl
+        prerelease: ${{ contains(github.ref, '-rc') }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

MANIFEST.in

@@ -0,0 +1,15 @@
+graft src
+
+include LICENSE
+include README.md
+include CONTRIBUTORS
+
+prune docs
+prune tests
+prune .github
+prune .tox
+
+exclude .gitignore
+exclude tox.ini
+
+global-exclude *.py[cod] __pycache__/* *.so *.dylib

tox.ini

@@ -3,6 +3,7 @@
 envlist =
     lint
     tests
+    build
 
 [testenv:tests]
 description = Run the tests of the Python package
@@ -32,6 +33,21 @@ commands =
     blackdoc --check --diff src tests
     isort --check-only --diff --extend-skip-glob "*/build/*" src tests
 
+[testenv:build]
+description = builds the package and checks integrity
+usedevelop = true
+deps =
+    build
+    check-manifest
+    twine
+allowlist_externals = rm
+commands_pre =
+    rm -f {toxinidir}/dist/*.whl
+    rm -f {toxinidir}/dist/*.tar.gz
+commands =
+    python -m build
+    twine check dist/*.tar.gz dist/*.whl
+    check-manifest {toxinidir}
 
 [testenv:format]
 description = Abuse tox to do actual formatting on all files.