Release v0.1 (blackjax-devs#22)

* add release github workflow
* relax JAX version
* add multiple chains example

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: release
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  release-job:
+    runs-on: ubuntu-latest
+    env:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install release tooling
+      run: |
+        pip install twine wheel
+    - name: Build package
+      run: |
+        python setup.py sdist bdist_wheel
+    - name: Check version number match
+      run: |
+        echo "GITHUB_REF: ${GITHUB_REF}"
+        # The GITHUB_REF should be something like "refs/tags/v3.x.x"
+        # Make sure the package version is the same as the tag
+        grep -Rq "^Version: ${GITHUB_REF:11}$" blackjax.egg-info/PKG-INFO
+    - name: Publish to PyPI
+      run: |
+        twine check dist/*
+        twine upload --repository pypi --username __token__ --password ${PYPI_TOKEN} dist/*
+  test-install-job:
+    needs: release-job
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Give PyPI some time to update the index
+      run: sleep 240
+    - name: Install from PyPI
+      run: |
+        pip install blackjax==${GITHUB_REF:11}

blackjax/__init__.py

@@ -1,5 +1,5 @@
 from . import hmc, inference
 
-__version__ = "0.0.1"
+__version__ = "0.1"
 
-__all__ = ["hmc", "inference"]
+__all__ = ["hmc", "nuts", "inference"]

requirements.txt

@@ -1,2 +1,2 @@
-jax==0.2.13
-jaxlib==0.1.67
+jax>=0.2.13
+jaxlib>=0.1.67

setup.py

@@ -1,19 +1,27 @@
 import codecs
 import os.path
+import sys
 
 import setuptools
 
 
+# READ README.md for long description on PyPi.
+try:
+    long_description = open("README.md", encoding="utf-8").read()
+except Exception as e:
+    sys.stderr.write("Failed to read README.md:\n  {}\n".format(e))
+    sys.stderr.flush()
+    long_description = ""
+
+
+# Get the package's version number of the __init__.py file
 def read(rel_path):
     """Read the file located at the provided relative path."""
     here = os.path.abspath(os.path.dirname(__file__))
     with codecs.open(os.path.join(here, rel_path), "r") as fp:
         return fp.read()
 
 
-INSTALL_REQS = read("requirements.txt").splitlines()
-
-
 def get_version(rel_path):
     """Get the package's version number.
 
@@ -30,11 +38,17 @@ def get_version(rel_path):
         raise RuntimeError("Unable to find version string.")
 
 
+INSTALL_REQS = read("requirements.txt").splitlines()
+
 setuptools.setup(
     name="blackjax",
+    author="The BlackJAX team",
     version=get_version("blackjax/__init__.py"),
     description="Flexible and fast inference in Python",
+    long_description=long_description,
     packages=setuptools.find_packages(),
-    install_requires=INSTALL_REQS
-   ,
+    install_requires=INSTALL_REQS,
+    long_description_content_type="text/markdown",
+    keywords="probabilistic machine learning bayesian statistics sampling algorithms",
+    license="Apache License 2.0",
 )