Be nicer about possible misconfigurations

.git_archival.txt

@@ -1,4 +1,3 @@
 node: $Format:%H$
 node-date: $Format:%cI$
 describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
-ref-names: $Format:%D$

.github/release.yml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

.github/workflows/python-tests.yml

@@ -43,6 +43,8 @@ jobs:
     name: ${{ matrix.os }} - Python ${{ matrix.python_version }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Setup python
         uses: actions/setup-python@v5
         if: matrix.python_version != 'msys2'

.pre-commit-config.yaml

@@ -1,45 +1,25 @@
-default_language_version:
-  python: python3.9
 repos:
--   repo: https://github.com/psf/black
-    rev: 23.12.1
-    hooks:
-    - id: black
-      args: [--safe, --quiet]
-      exclude: docs/examples/
--   repo: https://github.com/asottile/reorder-python-imports
-    rev: v3.12.0
-    hooks:
-    -   id: reorder-python-imports
-        args: [ "--application-directories=.:src" , --py38-plus, --add-import, 'from __future__ import annotations']
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: check-yaml
     -   id: debug-statements
--   repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-    -   id: flake8
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
-    hooks:
-    - id: pyupgrade
-      args: [--py38-plus]
 - repo: https://github.com/astral-sh/ruff-pre-commit
-  rev: v0.1.11
+  rev: v0.3.4
   hooks:
     - id: ruff
-      args: [--fix, --exit-non-zero-on-fix]
+      args: [--fix, --exit-non-zero-on-fix, --show-fixes]
+    - id: ruff-format
+
 - repo: https://github.com/tox-dev/pyproject-fmt
-  rev: "1.5.3"
+  rev: 1.7.0
   hooks:
     - id: pyproject-fmt
       exclude: docs/examples/
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 'v1.8.0'
+    rev: v1.9.0
     hooks:
     -   id: mypy
         args: [--strict]
@@ -51,3 +31,8 @@ repos:
             - importlib_metadata
             - typing-extensions>=4.5
             - rich
+
+-   repo: https://github.com/scientific-python/cookie
+    rev: 2024.04.23
+    hooks:
+      - id: sp-repo-review

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Unreleased
+
+## Changed
+
+- inclusion of `__all__` in autogenerated `version.py` files to aid IDE autoimports
 
 # v8.0.4
 
@@ -14,7 +19,7 @@
 
 - fix #925: allow `write_to` to be an absolute path when it's a subdirectory of the root
 - fix #932: ensure type annotations in version file don't cause linter issues
-- fix #930: temporary restore `DEFAULT_VERSION_SCHEME` and `DEFAULT_LOCAL_SCHEME` on the `setuptools_scm` package
+- fix #930: temporary restore `DEFAULT_VERSION_SCHEME` and `DEFAULT_LOCAL_SCHEME` on the `setuptools-scm` package
 
 
 
@@ -60,6 +65,7 @@
 - use normalized dist names for the `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${DIST_NAME}` env var
 - drop support for python 3.7
 - introduce `version_file` as replacement for `write_to`
+- renameed the project from `setuptools_scm` to `setuptools-scm`
 
 ## features
 

README.md

@@ -1,19 +1,21 @@
-# setuptools_scm
-[![github ci](https://github.com/pypa/setuptools_scm/workflows/python%20tests+artifacts+release/badge.svg)](https://github.com/pypa/setuptools_scm/actions)
+# setuptools-scm
+[![github ci](https://github.com/pypa/setuptools-scm/actions/workflows/python-tests.yml/badge.svg)](https://github.com/pypa/setuptools-scm/actions/workflows/python-tests.yml)
 [![Documentation Status](https://readthedocs.org/projects/setuptools-scm/badge/?version=latest)](https://setuptools-scm.readthedocs.io/en/latest/?badge=latest)
 [![tidelift](https://tidelift.com/badges/package/pypi/setuptools-scm) ](https://tidelift.com/subscription/pkg/pypi-setuptools-scm?utm_source=pypi-setuptools-scm&utm_medium=readme)
 
 ## about
 
-[setuptools-scm] extracts Python package versions from `git` or
-`hg` metadata instead of declaring them as the version argument
-or in an SCM managed file.
-
-Additionally, [setuptools-scm] provides setuptools
-with a list of files that are managed by the SCM <br/>
-(i.e. it automatically adds **all of** the SCM-managed files to the sdist).<br/>
-Unwanted files must be excluded via `MANIFEST.in`.
+[setuptools-scm] extracts Python package versions from `git` or `hg` metadata
+instead of declaring them as the version argument
+or in a Source Code Managed (SCM) managed file.
 
+Additionally [setuptools-scm] provides `setuptools` with a list of
+files that are managed by the SCM
+<br/>
+(i.e. it automatically adds all the SCM-managed files to the sdist).
+<br/>
+Unwanted files must be excluded via `MANIFEST.in`
+or [configuring Git archive][git-archive-docs].
 
 ## `pyproject.toml` usage
 
@@ -26,7 +28,7 @@ build step by specifying it as one of the build requirements.
 
 ```toml title="pyproject.toml"
 [build-system]
-requires = ["setuptools>=64", "setuptools_scm>=8"]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 ```
 
@@ -69,16 +71,17 @@ $ python -m setuptools_scm --help
 
 For further configuration see the [documentation].
 
-[setuptools-scm]: https://github.com/pypa/setuptools_scm
+[setuptools-scm]: https://github.com/pypa/setuptools-scm
 [documentation]: https://setuptools-scm.readthedocs.io/
+[git-archive-docs]: https://setuptools-scm.readthedocs.io/en/stable/usage/#builtin-mechanisms-for-obtaining-version-numbers
 
 
 ## Interaction with Enterprise Distributions
 
 Some enterprise distributions like RHEL7
 ship rather old setuptools versions.
 
-In those cases its typically possible to build by using an sdist against `setuptools_scm<2.0`.
+In those cases its typically possible to build by using an sdist against `setuptools-scm<2.0`.
 As those old setuptools versions lack sensible types for versions,
 modern [setuptools-scm] is unable to support them sensibly.
 

_own_version_helper.py

@@ -5,22 +5,24 @@
 it works only if the backend-path of the build-system section
 from pyproject.toml is respected
 """
+
 from __future__ import annotations
 
 import logging
+
 from typing import Callable
 
-from setuptools import build_meta as build_meta  # noqa
+from setuptools import build_meta as build_meta
 
-from setuptools_scm import _types as _t
 from setuptools_scm import Configuration
+from setuptools_scm import _types as _t
 from setuptools_scm import get_version
 from setuptools_scm import git
 from setuptools_scm import hg
 from setuptools_scm.fallbacks import parse_pkginfo
+from setuptools_scm.version import ScmVersion
 from setuptools_scm.version import get_local_node_and_date
 from setuptools_scm.version import guess_next_dev_version
-from setuptools_scm.version import ScmVersion
 
 log = logging.getLogger("setuptools_scm")
 # todo: take fake entrypoints from pyproject.toml

changelog.d/20240105_133254_subprocess_timeout_var.md

@@ -0,0 +1,4 @@
+
+### Changed
+
+- fix #957 - add subprocess timeout control env var

changelog.d/20240108_134756_cli_version_file_force.md

@@ -0,0 +1,30 @@
+
+### Added
+
+- fix #960: add a ``--force-write-version-files`` flag for the cli
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+<!--
+### Fixed
+
+- A bullet item for the Fixed category.
+
+-->
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

changelog.d/20240305_102047_allow_non_normalized_semver.md

@@ -0,0 +1,4 @@
+
+### Fixed
+
+- fix #1018: allow non-normalized versions for semver

docs/config.md

@@ -11,17 +11,19 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
 : Relative path to the SCM root, defaults to `.` and is relative to the file path passed in `relative_to`
 
 `version_scheme : str | Callable[[ScmVersion], str]`
-: Configures how the local version number is constructed; either an entrypoint name or a callable.
+: Configures how the version number is constructed; either an entrypoint name or a callable.
+  See [Version number construction](extending.md#setuptools_scmversion_scheme) for predefined implementations.
 
 `local_scheme : str | Callable[[ScmVersion], str]`
-: Configures how the local component of the version is constructed
+: Configures how the local component of the version (the optional part after the `+`) is constructed;
   either an entrypoint name or a callable.
+  See [Version number construction](extending.md#setuptools_scmlocal_scheme) for predefined implementations.
 
 
 `version_file: Path | PathLike[str] | None = None`
 :   A path to a file that gets replaced with a file containing the current
     version. It is ideal for creating a ``_version.py`` file within the
-    package, typically used to avoid using `pkg_resources.get_distribution`
+    package, typically used to avoid using `importlib.metadata`
     (which adds some overhead).
 
     !!! warning ""
@@ -30,8 +32,11 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
         for other file types it is necessary to provide `version_file_template`.
 
 `version_file_template: str | None = None`
-:   A new-style format string that is given the current version as
-    the `version` keyword argument for formatting.
+:   A new-style format string taking `version`, `scm_version` and `version_tuple` as parameters.
+    `version` is the generated next_version as string,
+    `version_tuple` is a tuple of split numbers/strings and
+    `scm_version` is the `ScmVersion` instance the current `version` was rendered from
+
 
 `write_to: Pathlike[str] | Path | None = None`
 :  (deprecated) legacy option to create a version file relative to the scm root
@@ -66,14 +71,14 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
 `fallback_version: str | None = None`
  :  A version string that will be used if no other method for detecting the
     version worked (e.g., when using a tarball with no metadata). If this is
-    unset (the default), `setuptools_scm` will error if it fails to detect the
+    unset (the default), `setuptools-scm` will error if it fails to detect the
     version.
 
 `parse: Callable[[Path, Config], ScmVersion] | None = None`
 :   A function that will be used instead of the discovered SCM
     for parsing the version. Use with caution,
     this is a function for advanced use and you should be
-    familiar with the `setuptools_scm` internals to use it.
+    familiar with the `setuptools-scm` internals to use it.
 
 `git_describe_command`
 :   This command will be used instead the default `git describe --long` command.
@@ -93,7 +98,7 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
 
     The [setuptools_scm.NonNormalizedVersion][] convenience class is
     provided to disable the normalization step done by
-    `packaging.version.Version`. If this is used while `setuptools_scm`
+    `packaging.version.Version`. If this is used while `setuptools-scm`
     is integrated in a setuptools packaging process, the non-normalized
     version number will appear in all files (see `version_file` note).
 
@@ -118,10 +123,10 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_
     in which case it will be an unparsed string.
     Specifying distribution-specific pretend versions will
     avoid possible collisions with third party distributions
-    also using ``setuptools_scm``
+    also using ``setuptools-scm``
 
     the dist name normalization follows adapted PEP 503 semantics, with one or
-    more of ".-_" being replaced by a single "_", and the name being upper-cased
+    more of ".-\_" being replaced by a single "\_", and the name being upper-cased
 
     this will take precedence over ``SETUPTOOLS_SCM_PRETEND_VERSION``
 

docs/customizing.md

@@ -3,10 +3,10 @@
 ## providing project local version schemes
 
 As PEP 621 provides no way to specify local code as a build backend plugin,
-setuptools_scm has to piggyback on setuptools for passing functions over.
+setuptools-scm has to piggyback on setuptools for passing functions over.
 
 To facilitate that one needs to write a `setup.py` file and
-pass partial setuptools_scm configuration in via the use_scm_version keyword.
+pass partial setuptools-scm configuration in via the use_scm_version keyword.
 
 It's strongly recommended to experiment with using stock version schemes or creating plugins as package.
 (This recommendation will change if there ever is something like build-time entrypoints).
@@ -33,7 +33,7 @@ setup(use_scm_version={"version_scheme": myversion_func})
 
 ``` { .toml title="pyproject.toml" file="docs/examples/version_scheme_code/pyproject.toml" }
 [build-system]
-requires = ["setuptools>=64", "setuptools_scm>=8"]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -52,7 +52,7 @@ dynamic = [
 
 ##  Importing in setup.py
 
-With the pep 517/518 build backend, setuptools_scm is importable from `setup.py`
+With the pep 517/518 build backend, setuptools-scm is importable from `setup.py`
 
 ``` { .python title="setup.py" }
 import setuptools

docs/examples/version_scheme_code/pyproject.toml

@@ -1,6 +1,6 @@
 # ~/~ begin <<docs/customizing.md#docs/examples/version_scheme_code/pyproject.toml>>[init]
 [build-system]
-requires = ["setuptools>=64", "setuptools_scm>=8"]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -10,4 +10,4 @@ dynamic = [
 ]
 
 [tool.setuptools_scm]
-# ~/~ end
+# ~/~ end

docs/extending.md

@@ -1,12 +1,12 @@
-# Extending setuptools_scm
+# Extending setuptools-scm
 
-`setuptools_scm` uses [entry-point][entry-point] based hooks to extend its default capabilities.
+`setuptools-scm` uses [entry-point][entry-point] based hooks to extend its default capabilities.
 
 [entry-point]: https://packaging.python.org/en/latest/specifications/entry-points/
 
 ## Adding a new SCM
 
-`setuptools_scm` provides two entrypoints for adding new SCMs:
+`setuptools-scm` provides two entrypoints for adding new SCMs:
 
 `setuptools_scm.parse_scm`
 :   A function used to parse the metadata of the current workdir
@@ -84,6 +84,11 @@ representing the version.
 `no-guess-dev`
 : Does no next version guessing, just adds `.post1.devN`
 
+`only-version`
+:   Only use the version from the tag, as given.
+
+    !!! warning "This means version is no longer pseudo unique per commit"
+
 
 ### `setuptools_scm.local_scheme`
 Configures how the local part of a version is rendered given a