Skip to content

Commit 227f302

Browse files
committed
Update flit description; add link to rationale
The 1st paragraph describes what Flit is and what it can do. The 2nd paragraph describes how it works and what is needed (or not) to use Flit.
1 parent a66d18c commit 227f302

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

source/key_projects.rst

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -370,19 +370,18 @@ flit
370370
`Issues <https://github.com/takluyver/flit/issues>`__ |
371371
`PyPI <https://pypi.org/project/flit>`__
372372

373-
Flit is a simple way to put Python packages and modules on PyPI. Flit packages
374-
a single importable module or package at a time, using the import name as the
375-
name on PyPI. All subpackages and data files within a package are included
376-
automatically. Flit requires Python 3, but you can use it to distribute modules
377-
for Python 2, so long as they can be imported on Python 3.
378-
379-
Flit provides its own implementation (instead of calling
380-
:ref:`distutils`, :ref:`distlib`, or :ref:`twine` abstractions) of PyPI package
381-
upload functionality. You can use it to quickly set up package
382-
configuration files for simple packages (instead of manually writing a
383-
file that works with :ref:`setuptools`), and build and upload packages to
384-
PyPI. All wheels built by flit are reproducible, which provides added
385-
verifiability.
373+
Flit provides a simple way to upload pure Python packages and modules to PyPI.
374+
It focuses on `making the easy things easy <flit-rationale_>`_ for packaging.
375+
Flit can generate a configuration file to quickly set up a simple project, build
376+
source distributions and wheels, and upload them to PyPI. Flit can also produce
377+
wheels in a reproducible manner, which provides added verifiability.
378+
379+
Flit uses ``pyproject.toml`` to configure a project. Flit does not rely on tools
380+
such as :ref:`setuptools` to build distributions, or :ref:`twine` to upload them
381+
to PyPI. Flit requires Python 3, but you can use it to distribute modules for
382+
Python 2, so long as they can be imported on Python 3.
383+
384+
.. _flit-rationale: https://flit.readthedocs.io/en/latest/rationale.html
386385

387386
.. _enscons:
388387

0 commit comments

Comments
 (0)