Merge pull request #16 from effigies/enh/pypi_deployment

ENH: Add PyPI deployment to GitHub action

Author: effigies

.github/workflows/pythonpackage.yml

@@ -6,6 +6,9 @@
 # Packages that use it probably do not want to continue testing with editable installations,
 # quadrupling their test load.
 
+# For deployment, it will be necessary to create a PyPI API token and store it as a secret
+# https://docs.github.com/en/actions/reference/encrypted-secrets
+
 name: Python package
 
 # Set once
@@ -15,11 +18,12 @@ env:
 on:
   push:
     branches: [ main ]
+    tags: [ '*' ]
   pull_request:
     branches: [ main ]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -50,3 +54,45 @@ jobs:
     - name: Test with pytest
       run: |
         pytest -sv --doctest-modules pydra/tasks/$SUBPACKAGE
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9]
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: recursive
+        fetch-depth: 0
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install build tools
+      run: python -m pip install --upgrade pip setuptools wheel twine
+    - name: Build source and wheel distributions
+      run: python setup.py sdist bdist_wheel
+    - name: Check distributions
+      run: twine check dist/*
+    - uses: actions/upload-artifact@v2
+      with:
+        name: distributions
+        path: dist/
+    # Deploy on tags if PYPI_API_TOKEN is defined in the repository secrets.
+    # Secrets are not accessible in the if: condition [0], so set an output variable [1]
+    # [0] https://github.community/t/16928
+    # [1] https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-output-parameter
+    - name: Check for PyPI token on tag
+      id: deployable
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+      env:
+        PYPI_API_TOKEN: "${{ secrets.PYPI_API_TOKEN }}"
+      run: if [ -n "$PYPI_API_TOKEN" ]; then echo ::set-output name=DEPLOY::true; fi
+    - name: Upload to PyPI
+      if: steps.deployable.outputs.DEPLOY
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

LICENSE

@@ -1,4 +1,4 @@
-   Copyright 2020 Nipype developers
+   Copyright 2021 Nipype developers
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -35,7 +35,10 @@ python setup.py sdist bdist_wheel
 twine upload dist/*
 ```
 
-Note that we assume tags will be version numbers and not be prefixed with `v` or some other
+Note that uploading to PyPI is done via [Continuous integration](#continuous-integration)) when
+a tag is pushed to the repository, so only the first step needs to be donne manually.
+
+Note also that we assume tags will be version numbers and not be prefixed with `v` or some other
 string. See Versioneer documentation for alternative configurations.
 
 ## Namespace packages
@@ -72,6 +75,10 @@ non-compliant package can potentially affect Pydra or other task packages.
 In addition to verifying installations do not break or conflict, pytest is run on the package,
 including all tests found in `test/` directories and [doctests].
 
+Finally, packages are built and uploaded as artifacts for inspection. When a tag is pushed,
+the packages are uploaded to PyPI if a valid [API token](https://pypi.org/help/#apitoken) is placed
+in the [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets).
+
 [doctests]: https://docs.python.org/3/library/doctest.html
 
 # Contributing to this template

setup.cfg

@@ -5,6 +5,20 @@ subpackage = TODO
 author = TODO
 author_email = TODO
 description = TODO
+long_description = file:README.md
+long_description_content_type = text/markdown; variant=CommonMark
+license = Apache License, 2.0
+classifiers =
+    Development Status :: 2 - Pre-Alpha
+    Environment :: Console
+    Intended Audience :: Science/Research
+    License :: OSI Approved :: Apache Software License
+    Operating System :: MacOS :: MacOS X
+    Operating System :: POSIX :: Linux
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Topic :: Scientific/Engineering
 
 [options]
 python_requires = >=3.7