Replace versioneer with setuptools-scm. (#24)

Author: tobiasraabe

.gitignore

@@ -13,3 +13,7 @@ __pycache__
 *.egg-info
 
 .pytask.sqlite3
+
+build
+dist
+src/pytask_parallel/_version.py

.pre-commit-config.yaml

@@ -30,6 +30,10 @@ repos:
     rev: v2.5.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.6b0
     hooks:
@@ -54,6 +58,7 @@ repos:
             flake8-print,
             flake8-pytest-style,
             flake8-todo,
+            flake8-typing-imports,
             flake8-unused-arguments,
             pep8-naming,
             pydocstyle,

CHANGES.rst

@@ -11,6 +11,8 @@ all releases are available on `PyPI <https://pypi.org/project/pytask-parallel>`_
 ------------------
 
 - :gh:`19` adds ``conda-forge`` to the ``README.rst``.
+- :gh:`22` add note that the debugger cannot be used together with pytask-parallel.
+- :gh:`24` replaces versioneer with setuptools-scm.
 
 
 0.0.8 - 2021-03-05

environment.yml

@@ -1,10 +1,14 @@
 name: pytask-parallel
+
 channels:
   - conda-forge
-  - pytask
+  - nodefaults
+
 dependencies:
   - python
   - pip
+  - setuptools_scm
+  - toml
 
   # Conda
   - anaconda-client
@@ -16,6 +20,15 @@ dependencies:
   - cloudpickle
   - loky
 
+  # pytask package dependencies
+  - attrs >=17.4.0
+  - click
+  - click-default-group
+  - networkx >=2.4
+  - pluggy
+  - pony >=0.7.13
+  - rich
+
   # Misc
   - black
   - bump2version

pyproject.toml

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

setup.cfg

@@ -1,7 +1,48 @@
-[versioneer]
-VCS = git
-style = pep440
-versionfile_source = src/pytask_parallel/_version.py
-versionfile_build = pytask_parallel/_version.py
-tag_prefix = v
-parentdir_prefix = pytask-parallel-
+[metadata]
+name = pytask_parallel
+description = Parallelize the execution of tasks with pytask.
+long_description = file: README.rst
+long_description_content_type = text/x-rst
+author = Tobias Raabe
+author_email = raabe@posteo.de
+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/pytask-parallel/blob/main/CHANGES.rst
+    Documentation = https://github.com/pytask-dev/pytask-parallel
+    Github = https://github.com/pytask-dev/pytask-parallel
+    Tracker = https://github.com/pytask-dev/pytask-parallel/issues
+
+[options]
+packages = find:
+install_requires =
+    click
+    cloudpickle
+    loky
+    pytask>=0.0.11
+python_requires = >=3.6
+include_package_data = True
+package_dir = =src
+zip_safe = False
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+pytask =
+    pytask_parallel = pytask_parallel.plugin
+
+[check-manifest]
+ignore =
+    src/pytask_parallel/_version.py

setup.py

@@ -1,54 +1,4 @@
-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/pytask-parallel",
-    "Github": "https://github.com/pytask-dev/pytask-parallel",
-    "Tracker": "https://github.com/pytask-dev/pytask-parallel/issues",
-    "Changelog": "https://github.com/pytask-dev/pytask-parallel/blob/main/CHANGES.rst",
-}
-
-
-setup(
-    name="pytask-parallel",
-    version=versioneer.get_version(),
-    cmdclass=versioneer.get_cmdclass(),
-    description="Parallelize the execution of pytask.",
-    long_description=README,
-    long_description_content_type="text/x-rst",
-    author="Tobias Raabe",
-    author_email="raabe@posteo.de",
-    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",
-    ],
-    install_requires=[
-        "click",
-        "cloudpickle",
-        "loky",
-        "pytask >= 0.0.11",
-    ],
-    platforms="any",
-    packages=find_packages(where="src"),
-    package_dir={"": "src"},
-    entry_points={"pytask": ["pytask_parallel = pytask_parallel.plugin"]},
-    include_package_data=True,
-    zip_safe=False,
-)
+if __name__ == "__main__":
+    setup()

src/pytask_parallel/__init__.py

@@ -1,5 +1,9 @@
-"""The entry-point for pytask-parallel."""
-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"
 
-__version__ = get_versions()["version"]
-del get_versions
+
+__all__ = ["__version__"]