Prepare to publish pytask-parallel on PyPI. (#13)

Author: tobiasraabe

.conda/bld.bat

@@ -12,10 +12,12 @@ source:
 build:
   noarch: python
   number: 0
+  script: {{ PYTHON }} setup.py install --single-version-externally-managed --record record.txt
 
 requirements:
   host:
     - python
+    - pip
     - setuptools
 
   run:
@@ -41,6 +43,7 @@ test:
 
 about:
   home: https://github.com/pytask-dev/pytask-parallel
-  license: none
+  license: MIT
+  license_file: LICENSE
   summary: Parallelize the execution of tasks.
   dev_url: https://github.com/pytask-dev/pytask-parallel

.conda/build.sh

@@ -0,0 +1 @@
+src/pytask_parallel/_version.py export-subst

.conda/meta.yaml

@@ -0,0 +1,36 @@
+name: PyPI
+
+on: push
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+
+    - name: Publish distribution 📦 to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitattributes

@@ -71,7 +71,12 @@ repos:
 - repo: https://github.com/codespell-project/codespell
   rev: v2.0.0
   hooks:
-    - id: codespell
+    -   id: codespell
+        args: [-L unparseable]
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.46"
+    hooks:
+    -   id: check-manifest
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

.github/workflows/publish-to-pypi.yml

@@ -3,14 +3,15 @@ Changes
 
 This is a record of all past pytask-parallel releases and what went into them in reverse
 chronological order. Releases follow `semantic versioning <https://semver.org/>`_ and
-all releases are available on `Anaconda.org
-<https://anaconda.org/pytask/pytask-parallel>`_.
+all releases are available on `PyPI <https://pypi.org/project/pytask-parallel>`_ and
+`Anaconda.org <https://anaconda.org/pytask/pytask-parallel>`_.
 
 
-0.0.6 - 2021-xx-xx
+0.0.6 - 2021-02-27
 ------------------
 
 - :gh:`12` replaces all occurrences of ``n_processes`` with ``n_workers``.
+- :gh:`13` adds a license, versioneer, and allows publishing on PyPI.
 
 
 0.0.5 - 2020-12-28

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+Copyright 2020-2021 Tobias Raabe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
+OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

CHANGES.rst

@@ -0,0 +1,11 @@
+include versioneer.py
+include src/pytask_parallel/_version.py
+include LICENSE
+
+exclude *.rst
+exclude *.yaml
+exclude *.yml
+exclude tox.ini
+
+prune .conda
+prune tests

LICENSE

@@ -1,15 +1,30 @@
+.. image:: https://img.shields.io/pypi/v/pytask-parallel?color=blue
+    :alt: PyPI
+    :target: https://pypi.org/project/pytask-parallel
+
+.. image:: https://img.shields.io/pypi/pyversions/pytask-parallel
+    :alt: PyPI - Python Version
+    :target: https://pypi.org/project/pytask-parallel
+
 .. image:: https://anaconda.org/pytask/pytask-parallel/badges/version.svg
     :target: https://anaconda.org/pytask/pytask-parallel
 
 .. image:: https://anaconda.org/pytask/pytask-parallel/badges/platforms.svg
     :target: https://anaconda.org/pytask/pytask-parallel
 
+.. image:: https://img.shields.io/pypi/l/pytask-parallel
+    :alt: PyPI - License
+
 .. image:: https://github.com/pytask-dev/pytask-parallel/workflows/Continuous%20Integration%20Workflow/badge.svg?branch=main
     :target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain
 
 .. image:: https://codecov.io/gh/pytask-dev/pytask-parallel/branch/main/graph/badge.svg
     :target: https://codecov.io/gh/pytask-dev/pytask-parallel
 
+.. image:: https://results.pre-commit.ci/badge/github/pytask-dev/pytask-parallel/main.svg
+    :target: https://results.pre-commit.ci/latest/github/pytask-dev/pytask-parallel/main
+    :alt: pre-commit.ci status
+
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/psf/black
 
@@ -25,10 +40,15 @@ Parallelize the execution of tasks with ``pytask-parallel`` which is a plugin fo
 Installation
 ------------
 
-Install the plugin via ``conda`` with
+pytask-parallel is available on `PyPI <https://pypi.org/project/pytask-parallel>`_ and
+`Anaconda.org <https://anaconda.org/pytask/pytask-parallel>`_. Install it with
 
 .. code-block:: console
 
+    $ pip install pytask-parallel
+
+    # or
+
     $ conda config --add channels conda-forge --add channels pytask
     $ conda install pytask-parallel