https://github.com/davidfritzsche/dflit
Fork of takluyver/flit, do not use
https://github.com/davidfritzsche/dflit
Last synced: 2 months ago
JSON representation
Fork of takluyver/flit, do not use
- Host: GitHub
- URL: https://github.com/davidfritzsche/dflit
- Owner: davidfritzsche
- License: bsd-3-clause
- Created: 2020-03-28T16:42:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-25T07:17:32.000Z (about 6 years ago)
- Last Synced: 2026-01-10T18:45:28.223Z (5 months ago)
- Language: Python
- Homepage:
- Size: 722 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
**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__``:
.. code-block:: python
"""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:
.. code-block:: ini
[build-system]
requires = ["flit_core >=2,<4"]
build-backend = "flit_core.buildapi"
[tool.flit.metadata]
module = "foobar"
author = "Sir Robin"
author-email = "robin@camelot.uk"
home-page = "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, it will still work for now, but you should convert it to
``pyproject.toml`` when convenient.
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.