Prepare to publish pytask on PyPI. (#67)

Author: tobiasraabe

.conda/meta.yaml

@@ -16,14 +16,22 @@ build:
     - pytask = _pytask.cli:cli
 
 requirements:
+  # The package dependencies must be specified under 'host' and 'run'.
   host:
     - python
     - pip
     - setuptools
 
+    - attrs >=17.4.0
+    - click
+    - click-default-group
+    - networkx
+    - pluggy
+    - pony >=0.7.13
+
   run:
     - python >=3.6
-    - setuptools
+
     - attrs >=17.4.0
     - click
     - click-default-group

.github/workflows/continuous-integration-workflow.yml

@@ -1,4 +1,5 @@
 name: Continuous Integration Workflow
+
 on:
   push:
     branches:

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

@@ -0,0 +1,39 @@
+name: PyPI
+
+on:
+  push:
+    branches:
+      - main
+
+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 }}

.gitignore

@@ -12,5 +12,9 @@ __pycache__
 _generated
 
 *.egg-info
+.eggs
 
 .pytask.sqlite3
+
+build
+dist

.pre-commit-config.yaml

@@ -74,6 +74,10 @@ repos:
     hooks:
     -   id: codespell
         args: [-L hist,-L unparseable]
+-   repo: https://github.com/mgedmin/check-manifest
+    rev: "0.46"
+    hooks:
+    -   id: check-manifest
 -   repo: meta
     hooks:
     -   id: check-hooks-apply

MANIFEST.in

@@ -1,2 +1,11 @@
+include LICENSE
 include versioneer.py
 include src/_pytask/_version.py
+
+exclude *.yaml
+exclude *.yml
+exclude tox.ini
+
+prune .conda
+prune docs
+prune tests

docs/changes.rst

@@ -14,7 +14,7 @@ all releases are available on `Anaconda.org <https://anaconda.org/pytask/pytask>
 - :gh:`60` adds the MIT license to the project and mentions pytest and its developers.
 - :gh:`65` adds versioneer to pytask and :gh:`66` corrects the coverage reports which
   were deflated due to the new files.
-
+- :gh:`67` prepares pytask to be published on PyPI.
 
 
 0.0.11 - 2020-12-27

setup.py

@@ -8,38 +8,54 @@
 
 
 DESCRIPTION = "In its highest aspirations, pytask tries to be pytest as a build system."
-README = Path("README.rst").read_text()
+
+# Remove the image from the README.rst since the raw directive is not allowed.
+README = "\n".join(Path("README.rst").read_text().split("\n")[5:])
+
 PROJECT_URLS = {
-    "Bug Tracker": "https://github.com/pytask-dev/pytask/issues",
     "Documentation": "https://pytask-dev.readthedocs.io/en/latest",
-    "Source Code": "https://github.com/pytask-dev/pytask",
+    "Github": "https://github.com/pytask-dev/pytask",
+    "Tracker": "https://github.com/pytask-dev/pytask/issues",
 }
 
+
 setup(
     name="pytask",
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
     description=DESCRIPTION,
-    long_description=DESCRIPTION + "\n\n" + README,
+    long_description=README,
     long_description_content_type="text/x-rst",
     author="Tobias Raabe",
     author_email="[email protected]",
-    python_requires=">=3.6",
-    url=PROJECT_URLS["Documentation"],
+    url=PROJECT_URLS["Github"],
     project_urls=PROJECT_URLS,
-    license="None",
-    keywords=["Build System"],
+    license="MIT",
     classifiers=[
-        "Development Status :: 2 - Pre-Alpha",
-        "Framework :: pytask",
+        "Development Status :: 3 - Alpha",
+        "Environment :: Console",
         "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Topic :: Scientific/Engineering",
+        "Topic :: Software Development :: Build Tools",
     ],
-    platforms="any",
+    install_requires=[
+        "attrs >= 17.4.0",
+        "click",
+        "click-default-group",
+        "networkx",
+        "pluggy",
+        "pony >= 0.7.13",
+    ],
+    python_requires=">=3.6",
     entry_points={"console_scripts": ["pytask=_pytask.cli:cli"]},
     packages=find_packages(where="src"),
     package_dir={"": "src"},
+    platforms="any",
+    include_package_data=True,
 )

src/_pytask/__init__.py

@@ -1,4 +1,5 @@
 from ._version import get_versions
 
 __version__ = get_versions()["version"]
+__git_version__ = get_versions()["full-revisionid"]
 del get_versions