Repository files navigation

Flit is a simple way to put Python packages and modules on PyPI.It tries to require less thought about packaging and help you avoid commonmistakes.SeeWhy use Flit? formore about how it compares to other Python packaging tools.

$ python3 -m pip install flit

Flit requires Python 3 and therefore needs to be installed using the Python 3version of pip.

Python 2 modules can be distributed using Flit, but need to be importable onPython 3 without errors.

Say you're writing a modulefoobar — either as a single filefoobar.py,or as a directory — and you want to distribute it.

1. Make sure that foobar's docstring starts with a one-line summary of whatthe module is, and that it has a__version__:

   """An amazing sample package!"""__version__="0.1"

2. Install flit if you don't already have it:

   python3 -m pip install flit

3. Runflit init in the directory containing the module to create apyproject.toml file. It will look something like this:

   [build-system]requires = ["flit_core >=3.2,<4"]build-backend ="flit_core.buildapi"[project]name ="foobar"authors = [{name ="Sir Robin",email ="robin@camelot.uk"}]dynamic = ["version","description"][project.urls]Home ="https://github.com/sirrobin/foobar"

   You can edit this file to add other metadata, for example to set upcommand line scripts. See thepyproject.toml pageof the documentation.

   If you have already got aflit.ini file to use with older versions ofFlit, convert it topyproject.toml by runningpython3 -m flit.tomlify.

4. Run this command to upload your code to PyPI:

   flit publish

Once your package is published, people can install it usingpip just likeany other package. In most cases, pip will download a 'wheel' package, astandard format it knows how to install. If you specifically ask pip to installan 'sdist' package, it will install and use Flit in a temporary environment.

To install a package locally for development, run:

flit install [--symlink] [--python path/to/python]

Flit packages a single importable module or package at a time, using the importname as the name on PyPI. All subpackages and data files within a package areincluded automatically.