# Buildsheet autogenerated by ravenadm tool -- Do not edit.

NAMEBASE=		python-incremental
VERSION=		24.7.2
KEYWORDS=		python
VARIANTS=		v12 v13
SDESC[v12]=		Library for versioning python projects (3.12)
SDESC[v13]=		Library for versioning python projects (3.13)
HOMEPAGE=		https://github.com/twisted/incremental
CONTACT=		Python_Automaton[python@ironwolf.systems]

DOWNLOAD_GROUPS=	main
SITES[main]=		PYPIWHL/0d/38/221e5b2ae676a3938c2c1919131410c342b6efc2baffeda395dd66eeca8f
DISTFILE[1]=		incremental-24.7.2-py3-none-any.whl:main
DIST_SUBDIR=		python-src
DF_INDEX=		1
SPKGS[v12]=		single
SPKGS[v13]=		single

OPTIONS_AVAILABLE=	PY312 PY313
OPTIONS_STANDARD=	none
VOPTS[v12]=		PY312=ON PY313=OFF
VOPTS[v13]=		PY312=OFF PY313=ON

DISTNAME=		incremental-24.7.2.dist-info

GENERATED=		yes

[PY312].RUN_DEPENDS_ON=			python-setuptools:single:v12
[PY312].USES_ON=			python:v12,wheel

[PY313].RUN_DEPENDS_ON=			python-setuptools:single:v13
[PY313].USES_ON=			python:v13,wheel

[FILE:2343:descriptions/desc.single]
Incremental
===========

|gha|
|pypi|
|coverage|

Incremental is a small library that versions your Python projects.

API documentation can be found [here].

.. contents::

Quick Start
-----------

Using setuptools
~~~~~~~~~~~~~~~~

Add Incremental to your ``pyproject.toml``:

.. code-block:: toml

    [build-system]
    requires = [
        "setuptools",
        "incremental>=24.7.2",  # ← Add incremental as a build dependency
   ]
    build-backend = "setuptools.build_meta"

    [project]
    name = "<projectname>"
    dynamic = ["version"]     # ← Mark the version dynamic
    dependencies = [
        "incremental>=24.7.2",  # ← Depend on incremental at runtime
   ]
    # ...

    [tool.incremental]        # ← Activate Incremental's setuptools
plugin

It's fine if the ``[tool.incremental]`` table is empty, but it must be
present.

Remove any ``[project] version = entry and any [tool.setuptools.dynamic]
version =`` entry.

Next, `initialize the project`_.

Using Hatchling
~~~~~~~~~~~~~~~

If you're using [Hatchling] to package your project,
activate Incremental's Hatchling plugin by altering your
``pyproject.toml``:

.. code:: toml

    [build-system]
    requires = [
        "hatchling",
        "incremental>=24.7.2",  # ← Add incremental as a build dependency
   ]
    build-backend = "hatchling.build"

    [project]
    name = "<projectname>"
    dynamic = ["version"]     # ← Mark the version dynamic
    dependencies = [
        "incremental>=24.7.2",  # ← Depend on incremental at runtime
   ]
    # ...

    [tool.hatch.version]
    source = "incremental"    # ← Activate Incremental's Hatchling plugin

Incremental can be configured as usual in an optional
``[tool.incremental]`` table.

The hatch version command will report the Incremental-managed version.
Use the ``python -m incremental.update`` command to change the version
(setting it with hatch version is not supported).

Next, `initialize the project`_.

Using ``setup.py``
~~~~~~~~~~~~~~~~~~

Incremental may be used from ``setup.py instead of pyproject.toml``.
Add this to your ``setup()`` call, removing any other versioning arguments:

.. code:: python

   setup(
       use_incremental=True,
       setup_requires=['incremental'],
       install_requires=['incremental'], # along with any other install
dependencies
       ...
   }


[FILE:125:distinfo]
8cb2c3431530bec48ad70513931a760f446ad6c25e8333ca5d95e24b0ed7b8fe        20516 python-src/incremental-24.7.2-py3-none-any.whl