Skip to content

Commit

Permalink
Call it "Hatchling"
Browse files Browse the repository at this point in the history
The PyPA packaging user guide refers to it as "Hatchling", so match that
terminology.
  • Loading branch information
twm committed Jul 20, 2024
1 parent d486e06 commit d2c45d7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
15 changes: 7 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Remove any ``[project] version =`` entry and any ``[tool.setuptools.dynamic] ver

Next, `initialize the project`_.

Using Hatch
~~~~~~~~~~~
Using Hatchling
~~~~~~~~~~~~~~~

If you're using `Hatch <https://hatch.pypa.io/>`_ to package your project,
activate Incremental's Hatch plugin by altering your ``pyproject.toml``:
If you're using `Hatchling <https://hatch.pypa.io/>`_ to package your project,
activate Incremental's Hatchling plugin by altering your ``pyproject.toml``:

.. code:: toml
Expand All @@ -69,14 +69,13 @@ activate Incremental's Hatch plugin by altering your ``pyproject.toml``:
# ...
[tool.hatch.version]
source = "incremental" # ← Activate Incremental's Hatch plugin
source = "incremental" # ← Activate Incremental's Hatchling plugin
The ``hatch version`` command will report the Incremental-managed version.
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).

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

Next, `initialize the project`_.

Using ``setup.py``
Expand Down
2 changes: 1 addition & 1 deletion src/incremental/newsfragments/93.feature
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Incremental now provides a `Hatch version source plugin <https://hatch.pypa.io/latest/plugins/version-source/reference/>`__.
Incremental now provides a `Hatchling version source plugin <https://hatch.pypa.io/latest/plugins/version-source/reference/>`_.

0 comments on commit d2c45d7

Please sign in to comment.