The pyproject.toml config file
This file lives next to the module or package.
Older version of Flit (up to 0.11) used a :doc:`flit.ini file <flit_ini>` for
similar information. Flit can still read these files for now, but you should
python3 -m flit.tomlify to convert a
flit.ini file to
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:
[build-system] requires = ["flit_core >=2,<3"] build-backend = "flit_core.buildapi"
This section is called
[tool.flit.metadata] in the file.
There are three required fields:
- The name of the module/package, as you'd use in an import statement.
- Your name
- Your email address
e.g. for flit itself
[tool.flit.metadata] module = "flit" author = "Thomas Kluyver" author-email = "email@example.com"
.. versionchanged:: 1.1 ``home-page`` was previously required.
The remaining fields are optional:
- A URL for the project, such as its Github repository.
A list of other packages from PyPI that this package needs. Each package may be followed by a version specifier like
>=4.1, and/or an environment marker after a semicolon. For example:
requires = [ "requests >=2.6", "configparser; python_version == '2.7'", ]
Lists of packages needed for every optional feature. The requirements are specified in the same format as for
requires. The requirements of the two reserved extras
docas well as the extra
devare installed by
flit install. For example:
[tool.flit.metadata.requires-extra] test = [ "pytest >=2.7.3", "pytest-cov", ] doc = ["sphinx"]
.. versionadded:: 1.1
- A path (relative to the .toml file) to a file containing a longer description
of your package to show on PyPI. This should be written in reStructuredText, Markdown or
plain text, and the filename should have the appropriate extension
- A list of Trove classifiers.
- A version specifier for the versions of Python this requires, e.g.
>=3.3,<4which are equivalents.
- If you want your package's name on PyPI to be different from the importable module name, set this to the PyPI name.
- Comma separated list of words to help with searching for your package.
- The name of a license, if you're using one for which there isn't a Trove classifier. It's recommended to use Trove classifiers instead of this in most cases.
- maintainer, maintainer-email
- Like author, for if you've taken over a project from someone else.
Here's the full metadata section from flit itself:
[tool.flit.metadata] module="flit" author="Thomas Kluyver" author-email="firstname.lastname@example.org" home-page="https://github.com/takluyver/flit" requires=[ "requests", "docutils", "requests_download", "pytoml", ] requires-python="3" description-file="README.rst" classifiers=[ "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 3", "Topic :: Software Development :: Libraries :: Python Modules", ]
Your project's page on pypi.org can show a number of
links, in addition to the required
home-page URL described above. You can
point people to documentation or a bug tracker, for example.
This section is called
[tool.flit.metadata.urls] in the file. You can use
any names inside it. Here it is for flit:
[tool.flit.metadata.urls] Documentation = "https://flit.readthedocs.io/en/latest/"
.. versionadded:: 1.0
This section is called
[tool.flit.scripts] in the file.
Each key and value describes a shell command to be installed along with
your package. These work like setuptools 'entry points'. Here's the section
[tool.flit.scripts] flit = "flit:main"
This will create a
flit command, which will call the function
imported from :mod:`flit`.
Entry points sections
[tool.flit.entrypoints."pygments.lexers"] dogelang = "dogelang.lexer:DogeLexer"
package:name value, the part before the colon should be an
importable module name, and the latter part should be the name of an object
accessible within that module. The details of what object to expose depend on
the application you're extending.
.. versionadded:: 2.0
When you use :ref:`build_cmd` or :ref:`publish_cmd`, Flit builds an sdist
(source distribution) tarball containing the files that are checked into version
control (git or mercurial). If you want more control, or it doesn't recognise
your version control system, you can give lists of paths or glob patterns as
exclude in this section. For example:
[tool.flit.sdist] include = ["doc/"] exclude = ["doc/*.html"]
- Always use
/as a separator (POSIX style)
- Must be relative paths from the directory containing
- Cannot go outside that directory (no
- Cannot contain control characters or
- Cannot use recursive glob patterns (
- Can refer to directories, in which case they include everything under the directory, including subdirectories
- Should match the case of the files they refer to, as case-insensitive matching is platform dependent
Exclusions have priority over inclusions.