Replace versioneer with setuptools-scm. (#10)

Author: tobiasraabe

.gitattributes

@@ -14,3 +14,7 @@ _generated
 *.egg-info
 
 .pytask.sqlite3
+
+build
+dist
+src/latex_dependency_scanner/_version.py

.gitignore

@@ -30,6 +30,10 @@ repos:
     rev: v2.6.0
     hooks:
     -   id: reorder-python-imports
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.17.0
+    hooks:
+    -   id: setup-cfg-fmt
 -   repo: https://github.com/psf/black
     rev: 21.7b0
     hooks:
@@ -53,6 +57,7 @@ repos:
             flake8-print,
             flake8-pytest-style,
             flake8-todo,
+            flake8-typing-imports,
             flake8-unused-arguments,
             pep8-naming,
             pydocstyle,

.pre-commit-config.yaml

@@ -14,6 +14,7 @@ in reverse chronological order. Releases follow `semantic versioning
 - :gh:`8` changes ``scan`` such that only one path to an image file is returned if the
   image extension is given and file does not exist. Also, beamer overlays are ignored.
   Thanks to :ghuser:`brettviren`!
+- :gh:`9` replaces versioneer with setuptools-scm.
 
 
 0.0.3 - 2021-03-05

CHANGES.rst

@@ -8,5 +8,3 @@ exclude tox.ini
 
 include README.rst
 include LICENSE
-include versioneer.py
-include src/latex_dependency_scanner/_version.py

MANIFEST.in

@@ -1,11 +1,14 @@
-name: latex-dependency-scanner
+name: lds
 
 channels:
   - conda-forge
+  - nodefaults
 
 dependencies:
-  - python=3.8
+  - python >=3.6
   - pip
+  - setuptools-scm
+  - toml
 
   # Testing
   - pytest

environment.yml

@@ -0,0 +1,6 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.0"]
+
+
+[tool.setuptools_scm]
+write_to = "src/latex_dependency_scanner/_version.py"

pyproject.toml

@@ -1,7 +1,35 @@
-[versioneer]
-VCS = git
-style = pep440
-versionfile_source = src/latex_dependency_scanner/_version.py
-versionfile_build = latex_dependency_scanner/_version.py
-tag_prefix = v
-parentdir_prefix = latex-dependency-scanner-
+[metadata]
+name = latex_dependency_scanner
+description = Scan LaTeX documents for their dependencies.
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+url = https://github.com/pytask-dev/latex-dependency-scanner
+author = Tobias Raabe
+author_email = [email protected]
+license = MIT
+license_file = LICENSE
+platforms = any
+classifiers =
+    Development Status :: 3 - Alpha
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3 :: Only
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+project_urls =
+    Changelog = https://github.com/pytask-dev/latex-dependency-scanner/blob/main/CHANGES.rst
+    Documentation = https://github.com/pytask-dev/latex-dependency-scanner
+    Github = https://github.com/pytask-dev/latex-dependency-scanner
+    Tracker = https://github.com/pytask-dev/latex-dependency-scanner/issues
+
+[options]
+packages = find:
+python_requires = >=3.6
+package_dir = =src
+zip_safe = False
+
+[options.packages.find]
+where = src

setup.cfg

@@ -1,46 +1,5 @@
-from pathlib import Path
-
-from setuptools import find_packages
 from setuptools import setup
 
-import versioneer
-
-README = Path("README.rst").read_text()
-
-PROJECT_URLS = {
-    "Documentation": "https://github.com/pytask-dev/latex-dependency-scanner",
-    "Github": "https://github.com/pytask-dev/latex-dependency-scanner",
-    "Tracker": "https://github.com/pytask-dev/latex-dependency-scanner/issues",
-    "Changelog": "https://github.com/pytask-dev/latex-dependency-scanner/blob/main/"
-    "CHANGES.rst",
-}
-
 
-setup(
-    name="latex-dependency-scanner",
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
-    description="Scan LaTeX documents for their dependencies.",
-    long_description=README,
-    long_description_content_type="text/x-rst",
-    author="Tobias Raabe",
-    author_email="[email protected]",
-    python_requires=">=3.6",
-    url=PROJECT_URLS["Github"],
-    project_urls=PROJECT_URLS,
-    license="MIT",
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-    ],
-    platforms="any",
-    packages=find_packages(where="src"),
-    package_dir={"": "src"},
-    zip_safe=False,
-)
+if __name__ == "__main__":
+    setup()

setup.py

@@ -2,10 +2,12 @@
 from latex_dependency_scanner.compile import compile_pdf
 from latex_dependency_scanner.scanner import scan
 
-from ._version import get_versions
+try:
+    from ._version import version as __version__
+except ImportError:
+    # broken installation, we don't even try unknown only works because we do poor mans
+    # version compare
+    __version__ = "unknown"
 
 
-__all__ = ["compile_pdf", "scan"]
-
-__version__ = get_versions()["version"]
-del get_versions
+__all__ = ["__version__", "compile_pdf", "scan"]