fix(build): migrate setup.py to pyproject.toml (#205) (#206)

This commit migrates the project from the setup.py
style of publishing to using pyproject.toml instead.

Signed-off-by: Phil Adams <[email protected]>

Author: padamstx

.bumpversion.toml

@@ -8,9 +8,9 @@ search = "__version__ = '{current_version}'"
 replace = "__version__ = '{new_version}'"
 
 [[tool.bumpversion.files]]
-filename = "setup.py"
-search = "__version__ = '{current_version}'"
-replace = "__version__ = '{new_version}'"
+filename = "pyproject.toml"
+search = "version = \"{current_version}\""
+replace = "version = \"{new_version}\""
 
 [[tool.bumpversion.files]]
 filename = "README.md"

.releaserc

@@ -8,7 +8,7 @@
     [
       "@semantic-release/exec", 
       {
-        "prepareCmd": "bump-my-version bump --allow-dirty --current-version ${lastRelease.version} --new-version ${nextRelease.version}"
+        "prepareCmd": "bump-my-version bump --allow-dirty --verbose --current-version ${lastRelease.version} --new-version ${nextRelease.version}"
       }
     ],
     [

.travis.yml

@@ -10,8 +10,7 @@ stages:
     if: (tag IS present) AND (fork = false)
 
 # Default "install" and "script" steps.
-install:
-  - pip install setuptools=="60.8.2"
+install: true
 script:
   - make ci
 
@@ -44,12 +43,7 @@ jobs:
     - stage: Publish-Release
       python: "3.8"
       name: Publish-To-PyPi
-      before_deploy:
-        - pip install bump-my-version
-      deploy:
-        - provider: pypi
-          setuptools_version: "60.8.2"
-          user: $PYPI_USER
-          password: $PYPI_TOKEN
-          repository: https://upload.pypi.org/legacy
-          skip_cleanup: true
+      script:
+        - make ci
+        - make publish-deps
+        - make publish-release

MANIFEST.in

@@ -1,3 +1 @@
-include requirements.txt
-include requirements-dev.txt
 include LICENSE

Makefile

@@ -3,32 +3,46 @@
 # example: "make setup"
 
 PYTHON=python3
+LINT=black
 LINT_DIRS=ibm_cloud_sdk_core test test_integration
 
-setup: deps dev_deps install_project
+setup: deps dev-deps install-project
 
-all: upgrade_pip setup test-unit lint
+all: upgrade-pip setup test-unit lint
 
-ci: setup test-unit lint
+ci: all
 
-upgrade_pip:
+publish-release: build-dist publish-dist
+
+upgrade-pip:
 	${PYTHON} -m pip install --upgrade pip
 
 deps:
-	${PYTHON} -m pip install -r requirements.txt
+	${PYTHON} -m pip install .
+
+dev-deps:
+	${PYTHON} -m pip install .[dev]
 
-dev_deps:
-	${PYTHON} -m pip install -r requirements-dev.txt
+publish-deps:
+	${PYTHON} -m pip install .[publish]
 
-install_project:
+install-project:
 	${PYTHON} -m pip install -e .
 
 test-unit:
 	${PYTHON} -m pytest --cov=ibm_cloud_sdk_core test
 
 lint:
 	${PYTHON} -m pylint ${LINT_DIRS}
-	black --check ${LINT_DIRS}
+	${LINT} --check ${LINT_DIRS}
 
 lint-fix:
-	black ${LINT_DIRS}
+	${LINT} ${LINT_DIRS}
+
+build-dist:
+	rm -fr dist
+	${PYTHON} -m build -s
+
+# This target requires the TWINE_PASSWORD env variable to be set to the user's pypi.org API token.
+publish-dist:
+	TWINE_USERNAME=__token__ ${PYTHON} -m twine upload --non-interactive --verbose dist/*.tar.gz

ibm_cloud_sdk_core/authenticators/cp4d_authenticator.py

@@ -62,7 +62,7 @@ def __init__(
         disable_ssl_verification: bool = False,
         headers: Optional[Dict[str, str]] = None,
         proxies: Optional[Dict[str, str]] = None,
-        verify: Optional[str] = None
+        verify: Optional[str] = None,
     ) -> None:
         # Check the type of `disable_ssl_verification`. Must be a bool.
         if not isinstance(disable_ssl_verification, bool):

ibm_cloud_sdk_core/authenticators/iam_authenticator.py

@@ -66,7 +66,7 @@ def __init__(
         disable_ssl_verification: bool = False,
         headers: Optional[Dict[str, str]] = None,
         proxies: Optional[Dict[str, str]] = None,
-        scope: Optional[str] = None
+        scope: Optional[str] = None,
     ) -> None:
         # Check the type of `disable_ssl_verification`. Must be a bool.
         if not isinstance(disable_ssl_verification, bool):

ibm_cloud_sdk_core/base_service.py

@@ -94,7 +94,7 @@ def __init__(
         service_url: str = None,
         authenticator: Authenticator = None,
         disable_ssl_verification: bool = False,
-        enable_gzip_compression: bool = False
+        enable_gzip_compression: bool = False,
     ) -> None:
         self.set_service_url(service_url)
         self.http_client = requests.Session()
@@ -364,7 +364,7 @@ def prepare_request(
         params: Optional[dict] = None,
         data: Optional[Union[str, dict]] = None,
         files: Optional[Union[Dict[str, Tuple[str]], List[Tuple[str, Tuple[str, ...]]]]] = None,
-        **kwargs
+        **kwargs,
     ) -> dict:
         """Build a dict that represents an HTTP service request.
 

ibm_cloud_sdk_core/detailed_response.py

@@ -40,7 +40,7 @@ def __init__(
         *,
         response: Optional[Union[dict, requests.Response]] = None,
         headers: Optional[Dict[str, str]] = None,
-        status_code: Optional[int] = None
+        status_code: Optional[int] = None,
     ) -> None:
         self.result = response
         self.headers = headers

ibm_cloud_sdk_core/token_managers/cp4d_token_manager.py

@@ -63,7 +63,7 @@ def __init__(
         disable_ssl_verification: bool = False,
         headers: Optional[Dict[str, str]] = None,
         proxies: Optional[Dict[str, str]] = None,
-        verify: Optional[str] = None
+        verify: Optional[str] = None,
     ) -> None:
         self.username = username
         self.password = password

ibm_cloud_sdk_core/token_managers/iam_token_manager.py

@@ -71,7 +71,7 @@ def __init__(
         disable_ssl_verification: bool = False,
         headers: Optional[Dict[str, str]] = None,
         proxies: Optional[Dict[str, str]] = None,
-        scope: Optional[str] = None
+        scope: Optional[str] = None,
     ) -> None:
         super().__init__(
             url=url,

pylint.sh

@@ -1,3 +1,66 @@
+[project]
+name = "ibm-cloud-sdk-core"
+version = "3.20.4"
+authors = [
+    { name="IBM", email="[email protected]" }
+]
+description = "Core library used by SDKs for IBM Cloud Services"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+keywords=["ibm", "cloud", "ibm cloud services"]
+dependencies = [
+    "requests>=2.31.0,<3.0.0",
+    "urllib3>=2.1.0,<3.0.0",
+    "python_dateutil>=2.8.2,<3.0.0",
+    "PyJWT>=2.8.0,<3.0.0",
+]
+
+[project.urls]
+Repository = "https://github.com/IBM/python-sdk-core"
+Documentation = "https://github.com/IBM/python-sdk-core/blob/main/README.md"
+Issues = "https://github.com/IBM/python-sdk-core/issues"
+Changelog = "https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md"
+Contributing = "https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md"
+License = "https://github.com/IBM/python-sdk-core/blob/main/LICENSE"
+
+[project.optional-dependencies]
+dev = [
+    "coverage>=7.3.2,<8.0.0",
+    "pylint>=3.0.0,<4.0.0",
+    "pytest>=7.4.2,<8.0.0",
+    "pytest-cov>=4.1.0,<5.0.0",
+    "responses>=0.23.3,<1.0.0",
+    "black>=24.0.0,<25.0.0",
+]
+publish = [
+    "build",
+    "twine"
+]
+
+[build-system]
+requires = ["setuptools>=67.7.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["ibm_cloud_sdk_core"]
+
 [tool.black]
 line-length = 120
 skip-string-normalization = true