{"author":null,"author_email":null,"bugtrack_url":null,"classifiers":["Framework :: Hatch","Framework :: Setuptools Plugin","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"Incremental\n===========\n\n|gha|\n|pypi|\n|coverage|\n\nIncremental is a small library that versions your Python projects.\n\nAPI documentation can be found `here `_.\n\n.. contents::\n\nQuick Start\n-----------\n\nUsing setuptools\n~~~~~~~~~~~~~~~~\n\nAdd Incremental to your ``pyproject.toml``:\n\n.. code-block:: toml\n\n [build-system]\n requires = [\n \"setuptools\",\n \"incremental>=24.7.2\", # ← Add incremental as a build dependency\n ]\n build-backend = \"setuptools.build_meta\"\n\n [project]\n name = \"\"\n dynamic = [\"version\"] # ← Mark the version dynamic\n dependencies = [\n \"incremental>=24.7.2\", # ← Depend on incremental at runtime\n ]\n # ...\n\n [tool.incremental] # ← Activate Incremental's setuptools plugin\n\nIt's fine if the ``[tool.incremental]`` table is empty, but it must be present.\n\nRemove any ``[project] version =`` entry and any ``[tool.setuptools.dynamic] version =`` entry.\n\nNext, `initialize the project`_.\n\nUsing Hatchling\n~~~~~~~~~~~~~~~\n\nIf you're using `Hatchling `_ to package your project,\nactivate Incremental's Hatchling plugin by altering your ``pyproject.toml``:\n\n.. code:: toml\n\n [build-system]\n requires = [\n \"hatchling\",\n \"incremental>=24.7.2\", # ← Add incremental as a build dependency\n ]\n build-backend = \"hatchling.build\"\n\n [project]\n name = \"\"\n dynamic = [\"version\"] # ← Mark the version dynamic\n dependencies = [\n \"incremental>=24.7.2\", # ← Depend on incremental at runtime\n ]\n # ...\n\n [tool.hatch.version]\n source = \"incremental\" # ← Activate Incremental's Hatchling plugin\n\nIncremental can be configured as usual in an optional ``[tool.incremental]`` table.\n\nThe ``hatch version`` command will report the Incremental-managed version.\nUse the ``python -m incremental.update`` command to change the version (setting it with ``hatch version`` is not supported).\n\nNext, `initialize the project`_.\n\n\nUsing ``setup.py``\n~~~~~~~~~~~~~~~~~~\n\nIncremental may be used from ``setup.py`` instead of ``pyproject.toml``.\nAdd this to your ``setup()`` call, removing any other versioning arguments:\n\n.. code:: python\n\n setup(\n use_incremental=True,\n setup_requires=['incremental'],\n install_requires=['incremental'], # along with any other install dependencies\n ...\n }\n\nThen `initialize the project`_.\n\n\nInitialize the project\n~~~~~~~~~~~~~~~~~~~~~~\n\nInstall Incremental to your local environment with ``pip install incremental[scripts]``.\nThen run ``python -m incremental.update --create``.\nIt will create a file in your package named ``_version.py`` like this:\n\n.. code:: python\n\n from incremental import Version\n\n __version__ = Version(\"\", 24, 1, 0)\n __all__ = [\"__version__\"]\n\n\nThen, so users of your project can find your version, in your root package's ``__init__.py`` add:\n\n.. code:: python\n\n from ._version import __version__\n\n\nSubsequent installations of your project will then use Incremental for versioning.\n\n\n\nIncremental Versions\n--------------------\n\n``incremental.Version`` is a class that represents a version of a given project.\nIt is made up of the following elements (which are given during instantiation):\n\n- ``package`` (required), the name of the package this ``Version`` represents.\n- ``major``, ``minor``, ``micro`` (all required), the X.Y.Z of your project's ``Version``.\n- ``release_candidate`` (optional), set to 0 or higher to mark this ``Version`` being of a release candidate (also sometimes called a \"prerelease\").\n- ``post`` (optional), set to 0 or higher to mark this ``Version`` as a postrelease.\n- ``dev`` (optional), set to 0 or higher to mark this ``Version`` as a development release.\n\nYou can extract a PEP-440 compatible version string by using the ``.public()`` method, which returns a ``str`` containing the full version. This is the version you should provide to users, or publicly use. An example output would be ``\"13.2.0\"``, ``\"17.1.2dev1\"``, or ``\"18.8.0rc2\"``.\n\nCalling ``repr()`` with a ``Version`` will give a Python-source-code representation of it, and calling ``str()`` on a ``Version`` produces a string like ``'[Incremental, version 16.10.1]'``.\n\n\nUpdating\n--------\n\nIncremental includes a tool to automate updating your Incremental-using project's version called ``incremental.update``.\nIt updates the ``_version.py`` file and automatically updates some uses of Incremental versions from an indeterminate version to the current one.\nIt requires ``click`` from PyPI.\n\n``python -m incremental.update `` will perform updates on that package.\nThe commands that can be given after that will determine what the next version is.\n\n- ``--newversion=``, to set the project version to a fully-specified version (like 1.2.3, or 17.1.0dev1).\n- ``--rc``, to set the project version to ``..0rc1`` if the current version is not a release candidate, or bump the release candidate number by 1 if it is.\n- ``--dev``, to set the project development release number to 0 if it is not a development release, or bump the development release number by 1 if it is.\n- ``--patch``, to increment the patch number of the release. This will also reset the release candidate number, pass ``--rc`` at the same time to increment the patch number and make it a release candidate.\n- ``--post``, to set the project postrelease number to 0 if it is not a postrelease, or bump the postrelease number by 1 if it is. This will also reset the release candidate and development release numbers.\n\nIf you give no arguments, it will strip the release candidate number, making it a \"full release\".\n\nIncremental supports \"indeterminate\" versions, as a stand-in for the next \"full\" version. This can be used when the version which will be displayed to the end-user is unknown (for example \"introduced in\" or \"deprecated in\"). Incremental supports the following indeterminate versions:\n\n- ``Version(\"\", \"NEXT\", 0, 0)``\n- `` NEXT``\n\nWhen you run ``python -m incremental.update --rc``, these will be updated to real versions (assuming the target final version is 17.1.0):\n\n- ``Version(\"\", 17, 1, 0, release_candidate=1)``\n- `` 17.1.0rc1``\n\nOnce the final version is made, it will become:\n\n- ``Version(\"\", 17, 1, 0)``\n- `` 17.1.0``\n\n\n.. |coverage| image:: https://codecov.io/gh/twisted/incremental/branch/master/graph/badge.svg?token=K2ieeL887X\n.. _coverage: https://codecov.io/gh/twisted/incremental\n\n.. |gha| image:: https://github.com/twisted/incremental/actions/workflows/tests.yaml/badge.svg\n.. _gha: https://github.com/twisted/incremental/actions/workflows/tests.yaml\n\n.. |pypi| image:: http://img.shields.io/pypi/v/incremental.svg\n.. _pypi: https://pypi.python.org/pypi/incremental\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":"Amber Brown ","name":"incremental","package_url":"https://pypi.org/project/incremental/","platform":null,"project_url":"https://pypi.org/project/incremental/","project_urls":{"Changelog":"https://github.com/twisted/incremental/blob/trunk/NEWS.rst","Documentation":"https://twisted.org/incremental/docs/","Homepage":"https://github.com/twisted/incremental","Issues":"https://github.com/twisted/incremental/issues"},"provides_extra":["scripts"],"release_url":"https://pypi.org/project/incremental/24.7.2/","requires_dist":["setuptools>=61.0","tomli; python_version < \"3.11\"","click>=6.0; extra == \"scripts\""],"requires_python":">=3.8","summary":"A small library that versions your Python projects.","version":"24.7.2","yanked":false,"yanked_reason":null}

Dependencies of incremental (3).
Dependency	Optional
setuptools	false
tomli	false
click	true

Package search

incremental

project_urls

Dependencies

All package metadata

Releases