Merge pull request #34 from adamtheturtle/twine

Progress towards a release

Author: adamtheturtle

CONTRIBUTING.rst

@@ -205,6 +205,38 @@ Prerequisites
 Perform a Release
 ~~~~~~~~~~~~~~~~~
 
+#. Install keyring
+
+   Make sure that `keyring <https://pypi.org/project/keyring/>`__ is available on your path.
+
+   E.g.:
+
+   .. code:: sh
+
+      curl https://raw.githubusercontent.com/mitsuhiko/pipsi/master/get-pipsi.py | python
+      pipsi install keyring
+
+#. Set up PyPI credentials
+
+Register at `PyPI <https://pypi.org>`__.
+
+Add the following information to ``~/.pypirc``.
+
+.. code:: ini
+
+   [distutils]
+    index-servers=
+        pypi
+
+    [pypi]
+    username = <Your PyPI username>
+
+Store your PyPI password:
+
+.. code:: sh
+
+   keyring set https://upload.pypi.org/legacy/ <Your PyPI username>
+
 #. Get a GitHub access token:
 
    Follow the `GitHub instructions <https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/>`__ for getting an access token.

Makefile

@@ -7,6 +7,7 @@ fix-yapf:
 		--recursive \
 		--exclude versioneer.py \
 		--exclude src/mock_vws/_version.py \
+		--exclude build \
 	    .
 
 .PHONY: autoflake
@@ -38,6 +39,7 @@ lint:
 		--diff \
 		--recursive \
 		--exclude versioneer.py \
+		--exclude build \
 		--exclude src/mock_vws/_version.py \
 		.
 

admin/release.py

@@ -107,6 +107,14 @@ def build() -> None:
         subprocess.run(args=args, check=True)
 
 
+def upload_to_pypi() -> None:
+    """
+    Upload builds to PyPI.
+    """
+    args = ['twine', 'upload', '-r', 'pypi', 'dist/*']
+    subprocess.run(args=args, check=True)
+
+
 def main() -> None:
     """
     Perform a release.
@@ -118,6 +126,7 @@ def main() -> None:
     update_changelog(version=version_str)
     commit_and_push(version=version_str, repository=repository)
     build()
+    upload_to_pypi()
     create_github_release(
         repository=repository,
         version=version_str,

dev-requirements.txt

@@ -10,6 +10,7 @@ flake8-quotes==1.0.0  # Require single quotes
 freezegun==0.3.10  # Freeze time in tests
 hypothesis==3.71.1  # Generate test cases
 isort==4.3.4  # Lint imports
+keyring==15.0.0
 mypy==0.620  # Type checking
 pip_check_reqs==2.0.3
 pydocstyle==2.1.1  # Lint docstrings
@@ -21,6 +22,7 @@ pytest-cov==2.6.0  # Measure code coverage
 pytest-envfiles==0.1.0  # Use files for environment variables for tests
 pytest==3.8.0  # Test runners
 timeout-decorator==0.4.0  # Decorate functions to time out.
+twine==1.11.0
 vulture==0.29
 yapf==0.24.0  # Automatic formatting for Python
-PyYAML==3.13
+PyYAML==3.13

setup.cfg

@@ -39,6 +39,7 @@ ignore =
 [flake8]
 exclude=./versioneer.py,
         ./src/mock_vws/_version.py,
+        ./build/,
 
 [versioneer]
 VCS = git