Skip to content

Commit

Permalink
Document version constraints for flit_core build dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
takluyver committed Jul 31, 2021
1 parent bc33d4d commit 3f5255a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion doc/pyproject_toml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 15,24 @@ Build system section
--------------------

This tells tools like pip to build your project with flit. It's a standard
defined by PEP 517. For any project using Flit, it will look like this:
defined by PEP 517. For any new project using Flit, it will look like this:

.. code-block:: toml
[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"
Version constraints:

- For now, all packages should specify ``<4``, so they won't be impacted by
changes in the next major version.
- :ref:`pyproject_toml_project` requires ``flit_core >=3.2``
- :ref:`pyproject_old_metadata` requires ``flit_core >=2,<4``
- The older :doc:`flit.ini file <flit_ini>` requires ``flit_core <3``.
- Only ``flit_core`` 2.x can build packages on Python 2, so packages still
supporting Python 2 cannot use new-style metadata (the ``[project]`` table).

.. _pyproject_toml_project:

New style metadata
Expand Down

0 comments on commit 3f5255a

Please sign in to comment.