Migrate to pyproject.toml

Author: mateuszmidor

.github/workflows/kentik-api.yml

@@ -39,23 +39,26 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
-      - name: Install requirements
+      - name: Install dependencies
         working-directory: ./kentik_api_library
-        run: pip3 install -r requirements.txt
-      - name: PyTest
-        working-directory: ./kentik_api_library
-        run: python3 setup.py pytest
+        run: |
+          set -xe
+          python -VV
+          python -m site
+          python -m pip install --upgrade -r requirements.txt
+          python -m pip install --upgrade -r requirements-dev.txt
       - name: Black
-        uses: piotrpawlaczek/python-blacken@release/stable
-        with:
-          path: './kentik_api_library'
-          line-length: '120'
-      - name: PyLint
         working-directory: ./kentik_api_library
-        run: python3 setup.py pylint
+        run: python3 setup.py black
       - name: Mypy
         working-directory: ./kentik_api_library
         run: python3 setup.py mypy
+      - name: PyLint
+        working-directory: ./kentik_api_library
+        run: python3 setup.py pylint
+      - name: PyTest
+        working-directory: ./kentik_api_library
+        run: python3 setup.py pytest
 
   build:
     needs: python-versions-setup

kentik_api_library/pyproject.toml

@@ -0,0 +1,28 @@
+[build-system]
+
+requires = ["setuptools", "wheel", "setuptools_scm", "gitpython", "pytest-runner", "pylint-runner"]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 120
+target-version = ['py39']
+check = true
+fast = true
+
+[tool.isort]
+profile = "black"
+known_local_folder = ["kentik_api", "examples", "tests"]
+line_length = 120
+
+[tool.mypy]
+ignore_missing_imports = true
+exclude = "(generated|build)/"
+
+[tool.pytest.ini_options]
+testpaths = ["tests/integration", "tests/unit"]
+
+[tool.pylint]
+
+[[tool.mypy.overrides]]
+module = "/generated/*"
+ignore_errors = true

kentik_api_library/requirements-dev.txt

@@ -0,0 +1,9 @@
+black==21.11b1
+isort==5.8.0
+mypy-extensions==0.4.3
+mypy==0.902
+pylint==2.8.3
+pytest-pylint==0.18.0
+pytest==6.2.4
+types-PyYAML==5.4.1
+types-requests==2.26.0

kentik_api_library/requirements.txt

@@ -7,25 +7,18 @@ fastparquet==0.6.3
 httpretty==1.1.3
 idna==2.10
 iniconfig==1.1.1
-isort==5.8.0
 lazy-object-proxy==1.6.0
 mccabe==0.6.1
-mypy-extensions==0.4.3
-mypy==0.902
 packaging==20.9
 pluggy==0.13.1
 py==1.10.0
-pylint==2.8.3
 pyparsing==2.4.7
-pytest-pylint==0.18.0
-pytest==6.2.4
 python-http-client==3.3.2
 requests[socks]==2.25.1
 six==1.16.0
 toml==0.10.2
 traitlets==5.0.5
 typed-ast==1.4.3
-types-PyYAML==5.4.1
 typing-extensions==3.10.0.0
 urllib3==1.26.4
 wheel==0.36.2

kentik_api_library/setup.cfg

@@ -1,5 +1,5 @@
-import distutils.cmd
-import distutils.log
+from distutils.cmd import Command
+from distutils import log
 import os
 import pathlib
 import subprocess
@@ -25,44 +25,41 @@
 ]
 
 
-class PylintCmd(distutils.cmd.Command):
+def run_cmd(cmd, reporter) -> None:
+    """Run arbitrary command as subprocess"""
+    reporter("Run command: {}".format(str(cmd)), level=log.DEBUG)
+    try:
+        subprocess.check_call(cmd)
+    except subprocess.CalledProcessError as ex:
+        reporter(str(ex), level=log.ERROR)
+        exit(1)
+
+
+class Pylint(Command):
     """Custom command to run Pylint"""
 
-    description = "run Pylint on src, tests and examples dir"
-    user_options = [
-        ("pylint-rcfile=", None, "path to Pylint config file"),
-    ]
+    description = "run Pylint on kentik_api, tests and examples directories; read configuratin from pyproject.toml"
+    user_options = []
 
     def initialize_options(self):
-        """Set default values for options."""
-        self.pylint_rcfile = ""
+        pass
 
     def finalize_options(self):
-        """Post-process options."""
-        if self.pylint_rcfile:
-            assert os.path.exists(self.pylint_rcfile), "Pylint config file {} does not exist.".format(
-                self.pylint_rcfile
-            )
+        pass
 
     def run(self):
         """Run command."""
-        cmd = ["pylint"]
-        paths = ["./kentik_api", "./tests", "./examples"]
-        if self.pylint_rcfile:
-            cmd.append("--rcfile={}".format(self.pylint_rcfile))
+        cmd = ["pylint", "--exit-zero"]
+        paths = ["kentik_api", "tests", "examples"]
         for path in paths:
             cmd.append(path)
-        self.announce("Running command: %s" % str(cmd), level=distutils.log.INFO)
-        try:
-            subprocess.check_call(cmd)
-        except subprocess.CalledProcessError:
-            pass
+        run_cmd(cmd, self.announce)
 
 
-class MypyCmd(distutils.cmd.Command):
+class Mypy(Command):
     """Custom command to run Mypy"""
 
-    description = "run Mypy on kentik_api directory"
+    description = "run Mypy on kentik_api, tests and examples directories; read configuratin from pyproject.toml"
     user_options = [("packages=", None, "Packages to check with mypy")]
 
     def initialize_options(self):
@@ -79,21 +76,47 @@ def run(self):
         cmd = ["mypy"]
         for package in self.packages:
             cmd.append(package)
-        self.announce("Run command: {}".format(str(cmd)), level=distutils.log.INFO)
-        try:
-            subprocess.check_call(cmd)
-        except subprocess.CalledProcessError:
-            self.announce(
-                "Command: {} returned error. Check if tests are not failing.".format(str(cmd)), level=distutils.log.INFO
-            )
+        run_cmd(cmd, self.announce)
+
+
+class Black(Command):
+    """Custom command to run black"""
+
+    description = "run black on all relevant code; read configuratin from pyproject.toml"
+    user_options = []
+
+    def initialize_options(self) -> None:
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        """Run command"""
+        cmd = ["black", "."]
+        run_cmd(cmd, self.announce)
+
+
+class PytestCmd(Command):
+    """Custom command to run pytest"""
+
+    description = "run pytest on all relevant code; read configuratin from pyproject.toml"
+    user_options = []
+
+    def initialize_options(self) -> None:
+        pass
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        """Run command"""
+        cmd = ["pytest"]
+        run_cmd(cmd, self.announce)
 
 
 setup(
     name="kentik-api",
-    use_scm_version={
-        "root": "..",
-        "relative_to": __file__,
-    },
     description="SDK library for Kentik API",
     maintainer="Martin Machacek",
     maintainer_email="[email protected]",
@@ -102,15 +125,13 @@ def run(self):
     url="https://github.com/kentik/community_sdk_python/tree/main/kentik_api_library",
     license="Apache-2.0",
     include_package_data=True,
+    python_requires=">=3.8, <4",
     install_requires=["dacite>=1.6.0", "requests[socks]>=2.25.0", "typing-extensions>=3.7.4.3", "urllib3>=1.26.0"],
-    setup_requires=["pytest-runner", "pylint-runner", "setuptools_scm", "wheel"],
     tests_require=["httpretty", "pytest", "pylint"],
-    extras_require={
-        "analytics": ["pandas>=1.2.4", "pyyaml>=5.4.1", "fastparquet>=0.6.3"],
-    },
+    extras_require={"analytics": ["pandas>=1.2.4", "pyyaml>=5.4.1", "fastparquet>=0.6.3"]},
     packages=PACKAGES,
     package_dir={pkg: os.path.join(*pkg.split(".")) for pkg in PACKAGES},
-    cmdclass={"pylint": PylintCmd, "mypy": MypyCmd},
+    cmdclass={"pylint": Pylint, "mypy": Mypy, "black": Black, "pytest": PytestCmd},
     classifiers=[
         "License :: OSI Approved :: Apache Software License",
     ],

kentik_api_library/setup.py

@@ -4,17 +4,13 @@
 
 
 def test_import(library=""):
-
-    library_found = False
-
+    error = None
     try:
-        imported_library = importlib.import_module(library)
-    except ImportError:
-        pass
-    else:
-        library_found = True
+        _ = importlib.import_module(library)
+    except ImportError as err:
+        error = err
 
-    assert library_found, "Can't import '" + library + "'"
+    assert error is None, f'Can\'t import "{library}": {error}'
 
 
 if __name__ == "__main__":