Switch to setuptools-scm (#267)

* Switch to setuptools-scm Signed-off-by: Patrick ZAJDA <[email protected]> * Exclude version file from Black and flake8 Signed-off-by: Patrick ZAJDA <[email protected]> * Add version file to .gitignore Signed-off-by: Patrick ZAJDA <[email protected]> * Exclude version from codecov Signed-off-by: Patrick ZAJDA <[email protected]> * Exclude __init__ from codecov, no code to be tested is in this module Signed-off-by: Patrick ZAJDA <[email protected]> --------- Signed-off-by: Patrick ZAJDA <[email protected]>
Nardol · Jan 11, 2024 · e48642c · e48642c
1 parent 95e3c91
commit e48642c
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Ignore version file
+src/pysmsboxnet/_version.py
diff --git a/codecov.yml b/codecov.yml
@@ -1,2 +1,5 @@
 comment: # this is a top-level key
   require_changes: true
+ignore:
+  - "src/pysmsboxnet/_version.py"
+  - "src/pysmsboxnet/__init__.py"
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [build-system]
-requires = [ "setuptools", "setuptools-git-versioning", ]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -48,9 +48,10 @@ include-package-data = false
 [tool.black]
 target-version = ["py39", "py310"]
 exclude = 'generated'
+extend-exclude = 'src/pysmsboxnet/_version.py'
 
 [tool.isort]
 profile = "black"
 
-[tool.setuptools-git-versioning]
-enabled = true
+[tool.setuptools_scm]
+version_file = "src/pysmsboxnet/_version.py"
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [flake8]
-exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build
+exclude = .venv,.git,.tox,docs,venv,bin,lib,deps,build,src/pysmsboxnet/_version.py
 max-complexity = 25
 doctests = True
 # To work with Black

diff --git a/src/pysmsboxnet/__init__.py b/src/pysmsboxnet/__init__.py
@@ -1 +1,7 @@
 """Python library to use smsbox.net API."""
+try:
+    from ._version import version as __version__  # type: ignore
+    from ._version import version_tuple  # type: ignore
+except ImportError:
+    __version__ = "unknown version"
+    version_tuple = (0, 0, "unknown version")