Change build system to setuptools and automate publishing to PyPI

#27

Update msodbcsql version used in integration test CI

Replace flit with setuptools as the build system

Disable mypy following imports in src/pytsql/grammar and remove some type ignore statements

Add a workflow for building the package and publishing it to PyPI

Remove the step for building wheels and rename the PyPI workflow

Add a missing newline

Clean up setup.cfg and add extra pip install flags to ci workflow

Add a job for uploading the package to TestPyPI

Update config to make local distribution version names compatible with TestPyPI

Create a custom setuptools_scm version scheme to enable non-duplicate TestPyPI release versions

Change git clone depth in build_and_publish workflow to get all tags

Update custom version scheme naming and add a dosctring to it

Fix a syntax error in build_and_publish.yml

Bring package metadata back to pyproject.toml

Change docstring mood to imperative

Co-authored-by: Kevin Klein <[email protected]>

Update a docstring to be more concise and informative

Co-authored-by: Kevin Klein <[email protected]>

Author: RokasUrbonasQC

.github/workflows/build_and_publish.yml

@@ -0,0 +1,55 @@
+name: Build and upload to PyPI
+
+on:
+  pull_request:
+  release:
+    types:
+      - published
+
+jobs:
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/*.tar.gz
+
+  upload_testpypi:
+    name: Upload to TestPyPI
+    needs: [build_sdist]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.TESTPYPI_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+
+  upload_pypi:
+    name: Upload to PyPI
+    needs: [build_sdist, upload_testpypi]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/ci.yaml

@@ -44,12 +44,12 @@ jobs:
       - name: Run Unit Tests
         shell: bash -l {0}
         run: |
-          flit install -s
+          pip install . --no-build-isolation --no-deps --disable-pip-version-check
           pytest tests/unit
 
   linux-integration_tests-sqlserver:
     name: "Linux - integration tests - Python ${{ matrix.PYTHON_VERSION }} - mssql"
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     env:
       CI: True
     strategy:
@@ -82,13 +82,13 @@ jobs:
       - name: Install msodbcsql17 driver
         shell: bash -l {0}
         run: |
-          wget https://packages.microsoft.com/ubuntu/20.04/prod/pool/main/m/msodbcsql17/msodbcsql17_17.9.1.1-1_amd64.deb
-          ACCEPT_EULA=Y sudo apt install ./msodbcsql17_17.9.1.1-1_amd64.deb
+          wget https://packages.microsoft.com/ubuntu/20.04/prod/pool/main/m/msodbcsql17/msodbcsql17_17.10.1.1-1_amd64.deb
+          ACCEPT_EULA=Y sudo apt install ./msodbcsql17_17.10.1.1-1_amd64.deb --allow-downgrades
       - name: Wait for SQL Server
         timeout-minutes: 1
         run: until docker logs "${{ job.services.db.id }}" 2>&1 | grep -q "SQL Server is now ready"; do sleep 10; done
       - name: Run Unit Tests
         shell: bash -l {0}
         run: |
-          flit install -s
+          pip install . --no-build-isolation --no-deps --disable-pip-version-check
           pytest --backend=mssql tests/integration

.pre-commit-config.yaml

@@ -19,10 +19,10 @@ repos:
       additional_dependencies: [toml]
       exclude: ^src/pytsql/grammar/
  - repo: https://github.com/Quantco/pre-commit-mirrors-mypy
-   rev: "0.790"
+   rev: "0.961"
    hooks:
     - id: mypy-conda
-      additional_dependencies: [ mypy=0.800, python=3.7.9 ]
+      additional_dependencies: [ -c, conda-forge, types-setuptools ]
       exclude: ^src/pytsql/grammar/
  - repo: https://github.com/Quantco/pre-commit-mirrors-pyupgrade
    rev: 2.7.2

environment.yml

@@ -3,8 +3,7 @@ channels:
   - conda-forge
   - nodefaults
 dependencies:
-  - flit-core
-  - flit
+  - setuptools_scm
   - pre-commit
   - pytest
   - pytest-mock
@@ -15,5 +14,5 @@ dependencies:
   - sphinx_rtd_theme
   - sphinxcontrib-apidoc
   - sqlalchemy
-  - antlr4-python3-runtime =4.9.2
+  - antlr-python-runtime==4.9.2
   - pyodbc

pyproject.toml

@@ -1,9 +1,10 @@
 [build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
+requires = ['setuptools', 'setuptools-scm', 'wheel']
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "pytsql"
+description = "`Pytsql` allows to run mssql sripts, typically run via GUIs, via CLI."
 authors = [
   {name = "Alex Gonopolskiy", email = "[email protected]"},
   {name = "Kevin Klein", email = "[email protected]"},
@@ -24,10 +25,13 @@ classifiers = [
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
   "Topic :: Database"
 ]
 readme = "README.md"
-dynamic = ["version", "description"]
+dynamic = ["version"]
 
 requires-python = ">=3.7.0"
 
@@ -40,7 +44,6 @@ dependencies = [
 [project.urls]
 Source = "https://github.com/quantco/pytsql"
 
-
 [tool.black]
 exclude = '''
 /(
@@ -60,3 +63,7 @@ line_length = 88
 known_first_party = "pytsql"
 skip_glob = '\.eggs/*,\.git/*,\.venv/*,build/*,dist/*'
 default_section = 'THIRDPARTY'
+
+[[tool.mypy.overrides]]
+module = "pytsql.grammar.*"
+follow_imports = "silent"

setup.py

@@ -0,0 +1,25 @@
+from time import time
+
+from setuptools import setup
+from setuptools_scm.version import ScmVersion
+
+
+def get_dev_timestamp(version: ScmVersion) -> str:
+    """Return a new distribution version string.
+
+    Returns the version found in the git tag if currently checked out commit has a tag.
+    Otherwise, returns the version found in the most recent git tag, appended with
+    `dev` and the current timestamp in seconds.
+    """
+
+    if version.exact:
+        return version.format_with("{tag}")
+    return version.format_with(f"{{tag}}.dev{int(time())}")
+
+
+setup(
+    use_scm_version={
+        "version_scheme": get_dev_timestamp,
+        "local_scheme": "dirty-tag",
+    },
+)

src/pytsql/__init__.py

@@ -1,8 +1,12 @@
 """`Pytsql` allows to run mssql sripts, typically run via GUIs, via CLI."""
 
+import pkg_resources
 
 from .tsql import execute, executes
 
-__version__ = "1.0.0"
+try:
+    __version__ = pkg_resources.get_distribution(__name__).version
+except Exception:
+    __version__ = "unknown"
 
 __all__ = ["execute", "executes"]

src/pytsql/grammar/__init__.py

@@ -1,5 +1,3 @@
-# flake8: noqa
-
-from .tsqlLexer import tsqlLexer  # type: ignore
-from .tsqlListener import tsqlListener  # type: ignore
-from .tsqlParser import tsqlParser  # type: ignore
+from .tsqlLexer import tsqlLexer
+from .tsqlListener import tsqlListener
+from .tsqlParser import tsqlParser

src/pytsql/grammar/tsqlLexer.py

@@ -1,5 +1,3 @@
-#type: ignore
-
 # Generated from tsql.g4 by ANTLR 4.9.2
 from antlr4 import *
 from io import StringIO

src/pytsql/grammar/tsqlListener.py

@@ -1,5 +1,3 @@
-#type: ignore
-
 # Generated from tsql.g4 by ANTLR 4.9.2
 from antlr4 import *
 if __name__ is not None and "." in __name__:

src/pytsql/grammar/tsqlParser.py

@@ -1,5 +1,3 @@
-#type: ignore
-
 # Generated from tsql.g4 by ANTLR 4.9.2
 # encoding: utf-8
 from antlr4 import *