chore: refactor release process (#1170)

Author: shania-m

.github/workflows/publish-package.yml

@@ -0,0 +1,52 @@
+# This workflow publishes the package to pypi.
+# For more details:
+# https://docs.github.com/en/actions/guides/building-and-testing-python#publishing-to-package-registries
+name: Publish to PyPi
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      # fetch all tags so `versioneer` can properly determine current version
+      with:
+        fetch-depth: 0
+    - name: Check if current commit is tagged
+      # fails and cancels release if the current commit is not tagged
+      run: |
+        git describe --exact-match --tags
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements-ml.txt ]; then pip install -r requirements-ml.txt; fi
+        if [ -f requirements-reports.txt ]; then pip install -r requirements-reports.txt; fi
+        pip install setuptools wheel twine
+    - name: Build
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_REPOSITORY: pypi
+      run: |
+        python setup.py sdist bdist_wheel
+    - name: Test build
+      # fails and cancels release if the built package fails to import
+      run: |
+        pip install dist/*.whl
+        python -c 'import data_profiler; print(data_profiler.__version__)'
+    - name: Publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        TWINE_REPOSITORY: pypi
+      run: |
+        twine upload dist/*

.github/workflows/publish-python-package.yml

@@ -7,8 +7,6 @@ on:
   pull_request:
     branches:
       - 'main'
-      - 'feature/**'
-      - 'dev'
 
 jobs:
   build:

.github/workflows/test-python-package.yml .github/workflows/test-package.yml

@@ -5,6 +5,7 @@ repos:
     rev: 22.3.0
     hooks:
       - id: black
+        exclude: (versioneer.py|dataprofiler/_version.py)
         types: [file, python]
         language_version: python3
   # Isort: sort import statements
@@ -41,7 +42,7 @@ repos:
     rev: v0.982
     hooks:
       - id: mypy
-        exclude: (^dataprofiler/tests/|^resources/|^examples|venv*/)
+        exclude: (^dataprofiler/tests/|^resources/|^examples|venv*/|versioneer.py|dataprofiler/_version.py)
         language_version: python3
         additional_dependencies: # Keep up-to-date with the respective requirement files
           [
@@ -117,6 +118,7 @@ repos:
     hooks:
       - id: pyupgrade
         args: ["--py38-plus"]
+        exclude: (versioneer.py|dataprofiler/_version.py)
   # Autoflake - cleanup unused variables and imports
   - repo: https://github.com/PyCQA/autoflake
     rev: v2.0.0

.pre-commit-config.yaml

@@ -18,3 +18,5 @@ recursive-include resources *.pb
 recursive-include resources *.py
 
 recursive-include dataprofiler/labelers/embeddings/ *.txt
+include versioneer.py
+include dataprofiler/_version.py

MANIFEST.in

@@ -1,5 +1,6 @@
 """Package for dataprofiler."""
 from . import settings
+from ._version import get_versions
 from .data_readers.data import Data
 from .dp_logging import get_logger, set_verbosity
 from .labelers.data_labelers import (
@@ -18,7 +19,8 @@
 from .profilers.profiler_options import ProfilerOptions
 from .reports import graphs
 from .validators.base_validators import Validator
-from .version import __version__
+
+__version__ = get_versions()["version"]
 
 
 def set_seed(seed=None):

dataprofiler/__init__.py

@@ -18,4 +18,5 @@ HLL>=2.0.3
 datasketches>=4.1.0
 packaging>=23.0
 boto3>=1.28.61
+versioneer
 # adding comment to trigger mend check

dataprofiler/_version.py

@@ -1,10 +1,19 @@
+[versioneer]
+vcs = git
+style = pep440
+versionfile_source = dataprofiler/_version.py
+versionfile_build = dataprofiler/_version.py
+tag_prefix = ""
+parentdir_prefix = dataprofiler-
 [flake8]
 max-line-length = 88
 extend-ignore = E203
+exclude = versioneer.py, dataprofiler/_version.py
 
 [isort]
+
 multi_line_output=3
-skip=dataprofiler/tests/data/,venv/
+skip=dataprofiler/tests/data/,venv/, versioneer.py, dataprofiler/_version.py
 profile=black
 include_trailing_comma=True
 force_grid_wrap=0

dataprofiler/version.py

@@ -10,7 +10,7 @@
 from setuptools import find_packages, setup
 
 # Load package version
-from dataprofiler.version import __version__
+import versioneer
 
 here = path.abspath(path.dirname(__file__))
 
@@ -53,7 +53,8 @@
 
 setup(
     name="DataProfiler",
-    version=__version__,
+    version=versioneer.get_version(),
+    cmdclass=versioneer.get_cmdclass(),
     python_requires=">=3.9",
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,