Implement release workflow in GitHub actions

- heavily based on @webknjaz's work on https://github.com/cherrypy/cheroot/blob/b2c619f3e60682b9405a87cea48e8d30801b6048/.github/workflows/ci-cd.yml
- create package before running tests, run tests against same package that will be published
- run nightly tests
- publish package to test pypi for commits to master
- publish package to pypi using workflow_dispatch
- create github tag and release after successful tests on workflow_dispatch
- packaging version is set from `setuptools-scm`
- self-reported `__version__` is dynamically determined using `pkg_resources`
- pyroma is removed due to incompatibilities with `setuptools-scm`: regebro/pyroma#69

CHANGES.txt

@@ -23,6 +23,7 @@ To be included in 1.0.0 (unreleased)
 * Fix error packet handling for SSCursor #428
 * Required python version is now properly documented in python_requires instead of failing on setup.py execution #731
 * Add rsa extras_require depending on PyMySQL[rsa] #557
+* Self-reported __version__ now returns version from installed package metadata, otherwise unknown #734
 
 
 0.0.22 (2021-11-14)

MANIFEST.in

@@ -1,5 +1,10 @@
-include LICENSE
-include CHANGES.txt
-include README.rst
-graft aiomysql
 global-exclude *.pyc *.swp
+exclude .coveragerc
+exclude .flake8
+exclude .github
+exclude .gitignore
+exclude docker-compose.yml
+exclude docs
+exclude examples
+exclude requirements-dev.txt
+exclude tests

Makefile

@@ -5,9 +5,6 @@ FLAGS=
 checkrst:
 	python setup.py check --restructuredtext
 
-pyroma:
-	pyroma -d .
-
 
 flake:checkrst pyroma
 	flake8 aiomysql tests examples

aiomysql/__init__.py

@@ -23,6 +23,11 @@
 
 """
 
+try:
+    import pkg_resources
+except ImportError:
+    pass
+
 from pymysql.converters import escape_dict, escape_sequence, escape_string
 from pymysql.err import (Warning, Error, InterfaceError, DataError,
                          DatabaseError, OperationalError, IntegrityError,
@@ -33,7 +38,10 @@
 from .cursors import Cursor, SSCursor, DictCursor, SSDictCursor
 from .pool import create_pool, Pool
 
-__version__ = '0.0.22'
+try:
+    __version__ = pkg_resources.get_distribution('aiomysql').version
+except Exception:
+    __version__ = 'unknown'
 
 __all__ = [
 

docs/conf.py

@@ -32,24 +32,6 @@
 
 import re, os.path
 
-def get_release():
-    regexp = re.compile(r"^__version__\W*=\W*'([\d.abrc]+)'")
-    here = os.path.dirname(__file__)
-    root = os.path.dirname(here)
-    init_py = os.path.join(root, 'aiomysql', '__init__.py')
-    with open(init_py) as f:
-        for line in f:
-            match = regexp.match(line)
-            if match is not None:
-                return match.group(1)
-        else:
-            raise RuntimeError('Cannot find version in aiomysql/__init__.py')
-
-
-def get_version(release):
-    parts = release.split('.')
-    return '.'.join(parts[:2])
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -78,13 +60,6 @@ def get_version(release):
 project = 'aiomysql'
 copyright = '2015,2016 Nikolay Novik'
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-release = get_release()
-version = get_version(release)
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None

pyproject.toml

@@ -0,0 +1,9 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "setuptools_scm[toml]>=6.4",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]

requirements-dev.txt

@@ -4,9 +4,8 @@ ipdb==0.13.9
 pytest==7.0.1
 pytest-cov==3.0.0
 pytest-sugar==0.9.4
-PyMySQL>=1.0.0,<=1.0.2
-sphinx>=1.8.1, <4.4.1
+PyMySQL==1.0.2
+Sphinx>=4.0
 sphinxcontrib-asyncio==0.3.0
-sqlalchemy>1.2.12,<=1.3.24
+sqlalchemy==1.3.24
 uvloop==0.16.0; python_version < '3.11'
-pyroma==3.2

setup.cfg

@@ -2,6 +2,11 @@
 name = aiomysql
 url = https://github.com/aio-libs/aiomysql
 download_url = https://pypi.python.org/pypi/aiomysql
+project_urls =
+  CI: GitHub = https://github.com/aio-libs/aiomysql/actions
+  Docs: RTD = https://aiomysql.readthedocs.io/
+  GitHub: issues = https://github.com/aio-libs/aiomysql/issues
+  GitHub: repo = https://github.com/aio-libs/aiomysql
 description = MySQL driver for asyncio.
 author = Nikolay Novik
 author_email = nickolainovik@gmail.com
@@ -29,10 +34,12 @@ platforms =
   POSIX
 
 [options]
+use_scm_version = True
 python_requires = >=3.7
 include_package_data = True
 
-# runtime requirements
+packages = find:
+
 install_requires =
   PyMySQL>=1.0
 
@@ -41,3 +48,8 @@ sa =
   sqlalchemy>=1.0,<1.4
 rsa =
   PyMySQL[rsa]>=1.0
+
+[options.packages.find]
+exclude =
+  tests
+  tests.*

setup.py

@@ -1,25 +1,11 @@
 import os
-import re
-from setuptools import setup, find_packages
+from setuptools import setup
 
 
 def read(f):
     return open(os.path.join(os.path.dirname(__file__), f)).read().strip()
 
 
-def read_version():
-    regexp = re.compile(r"^__version__\W*=\W*'([\d.abrc]+)'")
-    init_py = os.path.join(os.path.dirname(__file__),
-                           'aiomysql', '__init__.py')
-    with open(init_py) as f:
-        for line in f:
-            match = regexp.match(line)
-            if match is not None:
-                return match.group(1)
-        else:
-            raise RuntimeError('Cannot find version in aiomysql/__init__.py')
-
-
-setup(version=read_version(),
-      long_description='\n\n'.join((read('README.rst'), read('CHANGES.txt'))),
-      packages=find_packages(exclude=['tests', 'tests.*']))
+setup(
+    long_description='\n\n'.join((read('README.rst'), read('CHANGES.txt'))),
+)