Skip to content

Commit a254b8a

Browse files
authored
Merge pull request #739 from AA-Turner/bootstrap-tomllib
Update the bootstrap guide for ``tomllib``
2 parents 1c81417 + 148ac5c commit a254b8a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

doc/bootstrap.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,18 @@ included in the sdist (or by unzipping it to the correct directory)::
2626
# Install somewhere else:
2727
python bootstrap_install.py --installdir /path/to/site-packages dist/flit_core-*.whl
2828

29-
As of version 3.6, flit_core bundles the ``tomli`` TOML parser, to avoid a
30-
dependency cycle. If you need to unbundle it, you will need to special-case
31-
installing flit_core and/or tomli to get around that cycle.
29+
.. note::
30+
31+
This note only applies if you need to unbundle or unvendor dependencies.
32+
33+
``flit_core`` unconditionally bundles the ``tomli`` TOML parser,
34+
to avoid a dependency cycle for older versions of Python that don't include
35+
the standard library :mod:`tomllib` module.
36+
37+
The ``tomli`` library is only used on Python 3.10 and older, meaning that
38+
if you use Python 3.11 or newer you can simply remove the bundled ``tomli``.
39+
Otherwise, you must special-case installing ``flit_core`` and/or ``tomli``
40+
to resolve the dependency cycle between the two packages.
3241

3342
After ``flit_core``, I recommend that you get `installer
3443
<https://pypi.org/project/installer/>`_ set up. You can use

0 commit comments

Comments
 (0)