feat(pygitguardian): add pypi release channel

Author: João Guerreiro

.github/workflows/test-lint.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Package Test
+name: Main
 
 on: [push, pull_request]
 
@@ -30,8 +30,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: [3.6, 3.7, 3.8]
-
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -47,3 +47,24 @@ jobs:
         run: |
           pipenv run coverage run --source pygitguardian -m nose tests
           pipenv run coverage report --fail-under=80
+
+  release:
+    runs-on: ubuntu-latest
+    needs: [lint, build]
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip setuptools wheel
+      - name: Build distribution
+        run: >-
+          python setup.py sdist bdist_wheel
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: __token__
+          password: ${{ secrets.pypi_password }}

.gitignore

@@ -121,3 +121,4 @@ secret.py
 secrets
 
 Pipfile.lock
+dist/

README.md

@@ -1,4 +1,4 @@
-<img src="./doc/logo.svg">
+<img src="https://cdn.jsdelivr.net/gh/gitguardian/py-gitguardian/doc/logo.svg">
 
 # GitGuardian API Client
 

setup.py

@@ -1,34 +1,53 @@
+import io
+import os
 import re
-from os.path import abspath, dirname, join
 
 from setuptools import find_packages, setup
 
 
 VERSION_RE = re.compile(r"__version__\s*=\s*\"(.*?)\"")
+HERE = os.path.abspath(os.path.dirname(__file__))
 
 
-def readme():
-    with open(abspath("README.md")) as f:
-        return f.read()
+def read(*args):
+    """Reads complete file contents."""
+    return io.open(os.path.join(HERE, *args), encoding="utf-8").read()
 
 
-current_path = abspath(dirname(__file__))
+def get_version():
+    """Reads the version from this module."""
+    init = read("pygitguardian", "__init__.py")
+    return VERSION_RE.search(init).group(1)
 
-with open(join(current_path, "pygitguardian", "__init__.py")) as file:
-    content = file.read()
-    result = re.search(VERSION_RE, content)
-    if result is None:
-        raise Exception("could not find package version")
-    __version__ = result.group(1)
 
 setup(
     name="pygitguardian",
-    version=__version__,
+    version=get_version(),
     packages=find_packages(exclude=["tests"]),
-    description=readme(),
-    install_requires=["marshmallow>=3.5", "requests>=2"],
-    include_package_data=True,
+    description="Python Wrapper for GitGuardian's API -- Scan security policy breaks everywhere",
+    long_description=read("README.md"),
+    long_description_content_type="text/markdown",
+    url="https://github.com/GitGuardian/py-gitguardian",
     author="GitGuardian",
     author_email="[email protected]",
+    maintainer="GitGuardian",
+    install_requires=["marshmallow>=3.5", "requests>=2"],
+    include_package_data=True,
     zip_safe=True,
+    license="MIT",
+    keywords="api-client devsecops secrets-detection security-tools library gitguardian",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "Natural Language :: English",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Programming Language :: Python :: 3.7",
+        "Operating System :: OS Independent",
+        "Topic :: Security",
+    ],
 )