♻️ Remove incremental (#627)

* Remove incremental

* Add news fragment

* Update tutorial for accuracy around detecting versions

* review findings and fixes

* review findings

* revert RELEASE.rst

* fix rtd build

* Update src/towncrier/test/test_project.py

* fix coverage gaps

* fix coverage gap

* update RELEASE.rst

* Use 19.9.0 as an example to demonstrate how zero padding is used

---------

Co-authored-by: Chris Beaven <smileychris@gmail.com>
Co-authored-by: Hynek Schlawack <hs@ox.cx>
Co-authored-by: Adi Roiban <adiroiban@gmail.com>

.github/workflows/ci.yml

@@ -254,7 +254,7 @@ jobs:
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel
+        python -m pip install --upgrade pip wheel
         python -m pip install pep517
 
     - name: Display structure of files to be pushed

RELEASE.rst

@@ -15,13 +15,13 @@ Release candidate
 -----------------
 
 Create a release branch with a name of the form ``release-19.9.0`` starting from the main branch.
-The same branch is used for the release candidated and the final release.
+The same branch is used for the release candidate and the final release.
 In the end, the release branch is merged into the main branch.
 
 Update the version to the release candidate with the first being ``rc1`` (as opposed to 0).
-In ``src/towncrier/_version.py`` the version is set using ``incremental`` such as::
+In ``src/towncrier/_version.py`` the version is set using a PEP440 compliant string:
 
-    __version__ = Version('towncrier', 19, 9, 0, release_candidate=1)
+    __version__ = "19.9.0rc1"
 
 Run ``venv/bin/towncrier build --yes`` to generate the news release NEWS file.
 Commit and push to the primary repository, not a fork.
@@ -60,20 +60,20 @@ In the future we might create a separate Markdown version.
 
 
 Final release
---------------
+-------------
 
 Once the PR is approved, you can trigger the final release.
 
 Update the version to the final version.
-In ``src/towncrier/_version.py`` the version is set using ``incremental`` such as::
+In ``src/towncrier/_version.py`` the version is set using a PEP440 compliant string:
 
-    __version__ = Version('towncrier', 19, 9, 0)
+    __version__ = "19.9.0"
 
 Manually update the `NEWS.rst` file to include the final release version and date.
 Usually it will look like this.
 This will replace the release candidate section::
 
-    towncrier 19.9.0 (2019-09-29)
+    towncrier 19.9.0 (2019-09-01)
     =============================
 
     No significant changes since the previous release candidate.
@@ -87,7 +87,7 @@ Similar to the release candidate, with the difference:
 
 * tag will be named `19.9.0`
 * the target is the same branch
-* Title will be `towncrier 19.0.0`
+* Title will be `towncrier 19.9.0`
 * Content can be the content of the final release (RST format).
 * Check **Set as the latest release**.
 * Check **Create a discussion for this release**.
@@ -96,9 +96,9 @@ Similar to the release candidate, with the difference:
 No need for another review request.
 
 Update the version to the development version.
-In ``src/towncrier/_version.py`` the version is set using ``incremental`` such as::
+In ``src/towncrier/_version.py`` the version is set using a PEP440 compliant string:
 
-    __version__ = Version('towncrier', 19, 9, 1, dev=0)
+    __version__ = "19.9.0.dev0"
 
 Commit and push the changes.
 
@@ -111,6 +111,6 @@ With a squash merge, the whole branch history is lost.
 This causes the `pre-commit autoupdate` to fail.
 See `PR590 <https://github.com/twisted/towncrier/pull/590>`_ for more details.
 
-You can announce the release over IRC or Gitter.
+You can announce the release over IRC, Gitter, or Twisted mailing list.
 
 Done.

docs/conf.py

@@ -55,19 +55,17 @@
 project = "Towncrier"
 copyright = "{}, Towncrier contributors. Ver {}".format(
     _today.year,
-    towncrier_version.public(),
+    towncrier_version,
 )
 author = "Amber Brown"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 # The short X.Y version.
-version = "{}.{}.{}".format(
-    towncrier_version.major, towncrier_version.minor, towncrier_version.micro
-)
+version = ".".join(towncrier_version.split(".")[:3])
 # The full version, including alpha/beta/rc tags.
-release = towncrier_version.public()
+release = towncrier_version
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
     "hatchling",
-    "incremental == 22.10.0",
+    "wheel",
 ]
 build-backend = "hatchling.build"
 
@@ -32,8 +32,7 @@ dependencies = [
     "click",
     "importlib-resources>=5; python_version<'3.10'",
     "importlib-metadata>=4.6; python_version<'3.10'",
-    "incremental",
-    "jinja2>=3",
+    "jinja2",
     "tomli; python_version<'3.11'",
 ]
 
@@ -153,12 +152,6 @@ module = 'towncrier.click_default_group'
 # Vendored module without type annotations.
 ignore_errors = true
 
-[[tool.mypy.overrides]]
-module = 'incremental'
-# No released version with type hints.
-ignore_missing_imports = true
-
-
 [tool.coverage.run]
 parallel = true
 branch = true

src/towncrier/__init__.py

@@ -7,13 +7,11 @@
 
 from __future__ import annotations
 
-from incremental import Version
-
 
 __all__ = ["__version__"]
 
 
-def __getattr__(name: str) -> Version:
+def __getattr__(name: str) -> str:
     if name != "__version__":
         raise AttributeError(f"module {__name__} has no attribute {name}")
 

src/towncrier/_project.py

@@ -7,14 +7,12 @@
 
 from __future__ import annotations
 
+import contextlib
 import sys
 
 from importlib import import_module
 from importlib.metadata import version as metadata_version
 from types import ModuleType
-from typing import Any
-
-from incremental import Version as IncrementalVersion
 
 
 if sys.version_info >= (3, 10):
@@ -63,17 +61,15 @@ def get_version(package_dir: str, package: str) -> str:
     Try to extract the version from the distribution version metadata that matches
     `package`, then fall back to looking for the package in `package_dir`.
     """
-    version: Any
+    version: str | None
 
     # First try to get the version from the package metadata.
     if version := _get_metadata_version(package):
         return version
 
     # When no version if found, fall back to looking for the package in `package_dir`.
     module = _get_package(package_dir, package)
-
     version = getattr(module, "__version__", None)
-
     if not version:
         raise Exception(
             f"No __version__ or metadata version info for the '{package}' package."
@@ -82,37 +78,30 @@ def get_version(package_dir: str, package: str) -> str:
     if isinstance(version, str):
         return version.strip()
 
-    if isinstance(version, IncrementalVersion):
-        # FIXME:https://github.com/twisted/incremental/issues/81
-        # Incremental uses `.rcN`.
-        # importlib uses `rcN` (without a dot separation).
-        # Here we make incremental work like importlib.
-        return version.base().strip().replace(".rc", "rc")
-
     if isinstance(version, tuple):
         return ".".join(map(str, version)).strip()
 
+    # Try duck-typing as an Incremental version.
+    if hasattr(version, "base"):
+        try:
+            version = str(version.base()).strip()
+            # Incremental uses `X.Y.rcN`.
+            # Standardize on importlib (and PEP440) use of `X.YrcN`:
+            return version.replace(".rc", "rc")  # type: ignore
+        except TypeError:
+            pass
+
     raise Exception(
-        "I only know how to look at a __version__ that is a str, "
-        "an Increment Version, or a tuple. If you can't provide "
-        "that, use the --version argument and specify one."
+        "Version must be a string, tuple, or an Incremental Version."
+        " If you can't provide that, use the --version argument and specify one."
     )
 
 
 def get_project_name(package_dir: str, package: str) -> str:
     module = _get_package(package_dir, package)
-
     version = getattr(module, "__version__", None)
+    # Incremental has support for package names, try duck-typing it.
+    with contextlib.suppress(AttributeError):
+        return str(version.package)  # type: ignore
 
-    if not version:
-        # welp idk
-        return package.title()
-
-    if isinstance(version, str):
-        return package.title()
-
-    if isinstance(version, IncrementalVersion):
-        # Incremental has support for package names
-        return version.package
-
-    raise TypeError(f"Unsupported type for __version__: {type(version)}")
+    return package.title()

src/towncrier/_shell.py

@@ -19,7 +19,7 @@
 
 
 @click.group(cls=DefaultGroup, default="build", default_if_no_args=True)
-@click.version_option(__version__.public())
+@click.version_option(__version__)
 def cli() -> None:
     """
     Towncrier is a utility to produce useful, summarised news files for your project.

src/towncrier/_version.py

@@ -2,18 +2,11 @@
 Provides towncrier version information.
 """
 
-# This file is auto-generated! Do not edit!
-# Use `python -m incremental.update towncrier` to change this file.
-
-from incremental import Version
-
-
-# For dev   - Version('towncrier', 23, 8, 1, dev=0)
-# For RC    - Version('towncrier', 23, 9, 0, release_candidate=1)
-# For final - Version('towncrier', 23, 9, 0)
-__version__ = Version("towncrier", 23, 11, 1, dev=0)
-# The version is exposed in string format to be
-# available for the hatching build tools.
-_hatchling_version = __version__.short()
-
-__all__ = ["__version__", "_hatchling_version"]
+# For dev   - 23.11.1.dev0
+# For RC    - 23.11.1.rc1
+# For final - 23.11.1
+# make sure to follow PEP440
+__version__ = "23.11.1.dev0"
+
+_hatchling_version = __version__
+__all__ = ["_hatchling_version"]

src/towncrier/newsfragments/491.misc

@@ -0,0 +1,3 @@
+Remove incremental dependency from towncrier.
+
+Towncrier can still read incremental versions, it just doesn't rely on the package itself any more.

src/towncrier/test/test_packaging.py

@@ -1,22 +1,26 @@
 # Copyright (c) Amber Brown, 2015
 # See LICENSE for details.
 
-from incremental import Version
 from twisted.trial.unittest import TestCase
 
-from towncrier._version import _hatchling_version
+import towncrier
 
 
 class TestPackaging(TestCase):
-    def test_version_warning(self):
+    def test_version_attr(self):
         """
-        Import __version__ from towncrier returns an Incremental version object
-        and raises a warning.
+        towncrier.__version__ was deprecated, but still exists for now.
         """
-        with self.assertWarnsRegex(
-            DeprecationWarning, "Accessing towncrier.__version__ is deprecated.*"
-        ):
-            from towncrier import __version__
 
-        self.assertIsInstance(__version__, Version)
-        self.assertEqual(_hatchling_version, __version__.short())
+        def access__version():
+            return towncrier.__version__
+
+        expected_warning = (
+            "Accessing towncrier.__version__ is deprecated and will be "
+            "removed in a future release. Use importlib.metadata directly "
+            "to query for towncrier's packaging metadata."
+        )
+
+        self.assertWarns(
+            DeprecationWarning, expected_warning, __file__, access__version
+        )