build: add pyproject.toml, switch to versioningit

bastimeyer · back-to · commit 9b0815dbeeb5 · 2022-04-10T07:55:31.000+02:00
- Add basic pyproject.toml with build-system information
- Drop versioneer in favor of versioningit
- Delete versioneer install module and remove its setup.cfg config
- Replace `src/streamlink/_version.py` and load streamlink's version
  string via versioningit. The module's `__version__` export will get
  replaced by a static string on build-time when creating sdists/wheels,
  which results in the old versioneer behavior with support for
  editable installs.
- Make versioningit use the same version format as versioneer
- Update MANIFEST.in and .coveragerc
diff --git a/.coveragerc b/.coveragerc
@@ -7,7 +7,6 @@ source =
 omit =
   src/streamlink/packages/*
   src/streamlink_cli/packages/*
-  src/streamlink/_version.py
 
 exclude_lines =
     pragma: no cover
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -3,8 +3,6 @@ include CHANGELOG.md
 include README.md
 include LICENSE*
 include *requirements.txt
-include src/streamlink/_version.py
-include versioneer.py
 
 recursive-include completions *
 recursive-include docs *
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -7,3 +7,4 @@ freezegun>=1.0.0
 flake8
 flake8-import-order
 shtab
+versioningit >=1.1.1, <2
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,27 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = [
+  "setuptools >=45",
+  "wheel",
+  "versioningit >=1.1.1, <2",
+]
+
+
+# https://versioningit.readthedocs.io/en/stable/index.html
+[tool.versioningit]
+default-version = "0.0.0+unknown"
+
+[tool.versioningit.vcs]
+method = "git"
+
+[tool.versioningit.format]
+distance = "{version}+{distance}.{vcs}{rev}"
+dirty = "{version}+{distance}.{vcs}{rev}.dirty"
+distance-dirty = "{version}+{distance}.{vcs}{rev}.dirty"
+
+[tool.versioningit.next-version]
+method = "null"
+
+[tool.versioningit.onbuild]
+source-file = "src/streamlink/_version.py"
+build-file = "streamlink/_version.py"
diff --git a/setup.cfg b/setup.cfg
@@ -49,14 +49,6 @@ install_requires =
 [options.packages.find]
 where = src
 
-[versioneer]
-VCS = git
-style = pep440
-versionfile_source = src/streamlink/_version.py
-versionfile_build = streamlink/_version.py
-tag_prefix =
-parentdir_prefix = streamlink-
-
 [flake8]
 ignore =
   # W503 - line break before binary operator
diff --git a/setup.py b/setup.py
@@ -4,8 +4,7 @@
 from textwrap import dedent
 
 from setuptools import setup
-
-import versioneer
+from versioningit import get_cmdclasses
 
 
 def format_msg(text, *args, **kwargs):
@@ -77,8 +76,7 @@ def is_wheel_for_windows():
 
 
 setup(
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
+    cmdclass=get_cmdclasses(),
     entry_points=entry_points,
     data_files=data_files,
 )
diff --git a/src/streamlink/__init__.py b/src/streamlink/__init__.py
@@ -8,10 +8,8 @@
 Full documentation is available at https://streamlink.github.io.
 
 """
-from streamlink._version import get_versions
+from streamlink._version import __version__
 
-__version__ = get_versions()['version']
-del get_versions
 __title__ = "streamlink"
 __license__ = "Simplified BSD"
 __author__ = "Streamlink"
diff --git a/src/streamlink/_version.py b/src/streamlink/_version.py
diff --git a/versioneer.py b/versioneer.py
