| Name | flit JSON |
| Version |
3.10.1
JSON |
| download |
| home_page | None |
| Summary | A simple packaging tool for simple packages. |
| upload_time | 2024-11-02 16:22:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
**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? <https://flit.readthedocs.io/en/latest/rationale.html>`_ 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 >=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 up
command line scripts. See the
`pyproject.toml page <https://flit.readthedocs.io/en/latest/pyproject_toml.html#scripts-section>`_
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.
Raw data
{
"_id": null,
"home_page": null,
"name": "flit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Thomas Kluyver <thomas@kluyver.me.uk>",
"download_url": "https://files.pythonhosted.org/packages/03/46/f84b8815d161e7392d124d3de6e5880d1d36a74162a77a5e2839dc3c8c68/flit-3.10.1.tar.gz",
"platform": null,
"description": "**Flit** is a simple way to put Python packages and modules on PyPI.\nIt tries to require less thought about packaging and help you avoid common\nmistakes.\nSee `Why use Flit? <https://flit.readthedocs.io/en/latest/rationale.html>`_ for\nmore about how it compares to other Python packaging tools.\n\nInstall\n-------\n\n::\n\n $ python3 -m pip install flit\n\nFlit requires Python 3 and therefore needs to be installed using the Python 3\nversion of pip.\n\nPython 2 modules can be distributed using Flit, but need to be importable on\nPython 3 without errors.\n\nUsage\n-----\n\nSay you're writing a module ``foobar`` \u2014 either as a single file ``foobar.py``,\nor as a directory \u2014 and you want to distribute it.\n\n1. Make sure that foobar's docstring starts with a one-line summary of what\n the module is, and that it has a ``__version__``:\n\n .. code-block:: python\n\n \"\"\"An amazing sample package!\"\"\"\n\n __version__ = \"0.1\"\n\n2. Install flit if you don't already have it::\n\n python3 -m pip install flit\n\n3. Run ``flit init`` in the directory containing the module to create a\n ``pyproject.toml`` file. It will look something like this:\n\n .. code-block:: ini\n\n [build-system]\n requires = [\"flit_core >=3.2,<4\"]\n build-backend = \"flit_core.buildapi\"\n\n [project]\n name = \"foobar\"\n authors = [{name = \"Sir Robin\", email = \"robin@camelot.uk\"}]\n dynamic = [\"version\", \"description\"]\n\n [project.urls]\n Home = \"https://github.com/sirrobin/foobar\"\n\n You can edit this file to add other metadata, for example to set up\n command line scripts. See the\n `pyproject.toml page <https://flit.readthedocs.io/en/latest/pyproject_toml.html#scripts-section>`_\n of the documentation.\n\n If you have already got a ``flit.ini`` file to use with older versions of\n Flit, convert it to ``pyproject.toml`` by running ``python3 -m flit.tomlify``.\n\n4. Run this command to upload your code to PyPI::\n\n flit publish\n\nOnce your package is published, people can install it using *pip* just like\nany other package. In most cases, pip will download a 'wheel' package, a\nstandard format it knows how to install. If you specifically ask pip to install\nan 'sdist' package, it will install and use Flit in a temporary environment.\n\n\nTo install a package locally for development, run::\n\n flit install [--symlink] [--python path/to/python]\n\nFlit packages a single importable module or package at a time, using the import\nname as the name on PyPI. All subpackages and data files within a package are\nincluded automatically.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple packaging tool for simple packages.",
"version": "3.10.1",
"project_urls": {
"Changelog": "https://flit.pypa.io/en/stable/history.html",
"Documentation": "https://flit.pypa.io",
"Source": "https://github.com/pypa/flit"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b6bad88b8f3253b4af5a88559aede6345975cc2b18ed77bf8daf977bbb9df2c5",
"md5": "ec129f5f454f76380de6c709794c5a88",
"sha256": "d79c19c2caae73cc486d3d827af6a11c1a84b9efdfab8d9683b714ec8d1dc1f1"
},
"downloads": -1,
"filename": "flit-3.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec129f5f454f76380de6c709794c5a88",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 50683,
"upload_time": "2024-11-02T16:22:05",
"upload_time_iso_8601": "2024-11-02T16:22:05.702759Z",
"url": "https://files.pythonhosted.org/packages/b6/ba/d88b8f3253b4af5a88559aede6345975cc2b18ed77bf8daf977bbb9df2c5/flit-3.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0346f84b8815d161e7392d124d3de6e5880d1d36a74162a77a5e2839dc3c8c68",
"md5": "bae96bc842daf0ff81202db673f345c7",
"sha256": "9c6258ae76d218ce60f9e39a43ca42006a3abcc5c44ea6bb2a1daa13857a8f1a"
},
"downloads": -1,
"filename": "flit-3.10.1.tar.gz",
"has_sig": false,
"md5_digest": "bae96bc842daf0ff81202db673f345c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 143162,
"upload_time": "2024-11-02T16:22:09",
"upload_time_iso_8601": "2024-11-02T16:22:09.488412Z",
"url": "https://files.pythonhosted.org/packages/03/46/f84b8815d161e7392d124d3de6e5880d1d36a74162a77a5e2839dc3c8c68/flit-3.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 16:22:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypa",
"github_project": "flit",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "flit"
}
