Skip to main content

A simple packaging tool for simple packages.

Project description

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 common mistakes. See Why use Flit? for more about how it compares to other Python packaging tools.

Install

$ python3 -m pip install flit

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

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

Usage

Say you’re writing a module foobar — either as a single file foobar.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 what the 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. Run flit init in the directory containing the module to create a pyproject.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 = "[email protected]"}]
    dynamic = ["version", "description"]
    
    [project.urls]
    Home = "https://github.com/sirrobin/foobar"

    You can edit this file to add other metadata, for example to set up command line scripts. See the pyproject.toml page of the documentation.

    If you have already got a flit.ini file to use with older versions of Flit, convert it to pyproject.toml by running python3 -m flit.tomlify.

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

    flit publish

Once your package is published, people can install it using pip just like any other package. In most cases, pip will download a ‘wheel’ package, a standard format it knows how to install. If you specifically ask pip to install an ‘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 import name as the name on PyPI. All subpackages and data files within a package are included automatically.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flit-3.10.1.tar.gz (143.2 kB view details)

Uploaded Source

Built Distribution

flit-3.10.1-py3-none-any.whl (50.7 kB view details)

Uploaded Python 3

File details

Details for the file flit-3.10.1.tar.gz.

File metadata

  • Download URL: flit-3.10.1.tar.gz
  • Upload date:
  • Size: 143.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for flit-3.10.1.tar.gz
Algorithm Hash digest
SHA256 9c6258ae76d218ce60f9e39a43ca42006a3abcc5c44ea6bb2a1daa13857a8f1a
MD5 bae96bc842daf0ff81202db673f345c7
BLAKE2b-256 0346f84b8815d161e7392d124d3de6e5880d1d36a74162a77a5e2839dc3c8c68

See more details on using hashes here.

Provenance

The following attestation bundles were made for flit-3.10.1.tar.gz:

Publisher: test.yml on pypa/flit

Attestations:

File details

Details for the file flit-3.10.1-py3-none-any.whl.

File metadata

  • Download URL: flit-3.10.1-py3-none-any.whl
  • Upload date:
  • Size: 50.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for flit-3.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d79c19c2caae73cc486d3d827af6a11c1a84b9efdfab8d9683b714ec8d1dc1f1
MD5 ec129f5f454f76380de6c709794c5a88
BLAKE2b-256 b6bad88b8f3253b4af5a88559aede6345975cc2b18ed77bf8daf977bbb9df2c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for flit-3.10.1-py3-none-any.whl:

Publisher: test.yml on pypa/flit

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page