# feu :fire:
<p align="center">
<a href="https://github.com/durandtibo/feu/actions">
<img alt="CI" src="https://github.com/durandtibo/feu/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/feu/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/feu/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/feu/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/feu/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/feu/">
<img alt="Documentation" src="https://github.com/durandtibo/feu/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/feu/">
<img alt="Documentation" src="https://github.com/durandtibo/feu/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/feu">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/feu/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/feu/maintainability">
<img src="https://api.codeclimate.com/v1/badges/173c4176f130dd424881/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/feu/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/173c4176f130dd424881/test_coverage" />
</a>
<br/>
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings">
<img alt="Doc style: google" src="https://img.shields.io/badge/%20style-google-3666d6.svg">
</a>
<a href="https://github.com/astral-sh/ruff">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;">
</a>
<a href="https://github.com/guilatrova/tryceratops">
<img alt="Doc style: google" src="https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black">
</a>
<br/>
<a href="https://pypi.org/project/feu/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/feu">
</a>
<a href="https://pypi.org/project/feu/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/feu.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/feu">
</a>
<br/>
<a href="https://pepy.tech/project/feu">
<img alt="Downloads" src="https://static.pepy.tech/badge/feu">
</a>
<a href="https://pepy.tech/project/feu">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/feu/month">
</a>
<br/>
</p>
## Overview
`feu` is a light Python library to help to manage packages.
- [Documentation](https://durandtibo.github.io/feu/)
- [Installation](#installation)
- [Contributing](#contributing)
- [API stability](#api-stability)
- [License](#license)
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`feu` can be installed from pip using the following command:
```shell
pip install feu
```
To make the package as slim as possible, only the minimal packages required to use `feu` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install feu[all]
```
Please check the [get started page](https://durandtibo.github.io/feu/get_started) to see how to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `feu` versions and supported dependencies.
| `feu` | `packaging` | `python` | `click`<sup>*</sup> |
|---------|----------------|---------------|---------------------|
| `main` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |
| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |
| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |
| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |
| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |
| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |
| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |
| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |
<sup>*</sup> indicates an optional dependency
<details>
<summary>older versions</summary>
| `feu` | `packaging` | `python` | `click`<sup>*</sup> | `fire`<sup>*</sup> |
|---------|----------------|---------------|---------------------|--------------------|
| `0.1.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | | `>=0.6.0,<1.0` |
| `0.1.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | | `>=0.6.0,<1.0` |
| `0.0.7` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |
| `0.0.6` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |
| `0.0.5` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |
| `0.0.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |
| `0.0.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |
| `0.0.2` | `>=22.0,<24.0` | `>=3.9,<3.13` | | |
| `0.0.1` | `>=22.0,<23.3` | `>=3.9,<3.13` | | |
</details>
## Contributing
Please check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).
## Suggestions and Communication
Everyone is welcome to contribute to the community.
If you have any questions or suggestions, you can
submit [Github Issues](https://github.com/durandtibo/feu/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `feu` is in development stage, no API is guaranteed to be stable from one
release to the next.
In fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.
In practice, this means that upgrading `feu` to a new version will possibly break any code that
was using the old version of `feu`.
## License
`feu` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
file.
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/feu",
"name": "feu",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": "package, install, dependency",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7c/3b/951f3f9c92ecb3e296b525236e9046bb3d48b5b3fc62be17d544bec165b9/feu-0.3.1.tar.gz",
"platform": null,
"description": "# feu :fire:\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/feu/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/feu/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/feu/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/feu/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/feu/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/feu/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/feu/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/feu/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/feu/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/feu/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/feu\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/feu/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/feu/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/173c4176f130dd424881/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/feu/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/173c4176f130dd424881/test_coverage\" />\n </a>\n <br/>\n <a href=\"https://github.com/psf/black\">\n <img alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\">\n </a>\n <a href=\"https://google.github.io/styleguide/pyguide.html#s3.8-comments-and-docstrings\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/%20style-google-3666d6.svg\">\n </a>\n <a href=\"https://github.com/astral-sh/ruff\">\n <img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\" alt=\"Ruff\" style=\"max-width:100%;\">\n </a>\n <a href=\"https://github.com/guilatrova/tryceratops\">\n <img alt=\"Doc style: google\" src=\"https://img.shields.io/badge/try%2Fexcept%20style-tryceratops%20%F0%9F%A6%96%E2%9C%A8-black\">\n </a>\n <br/>\n <a href=\"https://pypi.org/project/feu/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/feu\">\n </a>\n <a href=\"https://pypi.org/project/feu/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/feu.svg\">\n </a>\n <a href=\"https://opensource.org/licenses/BSD-3-Clause\">\n <img alt=\"BSD-3-Clause\" src=\"https://img.shields.io/pypi/l/feu\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/feu\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/feu\">\n </a>\n <a href=\"https://pepy.tech/project/feu\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/feu/month\">\n </a>\n <br/>\n</p>\n\n## Overview\n\n`feu` is a light Python library to help to manage packages.\n\n- [Documentation](https://durandtibo.github.io/feu/)\n- [Installation](#installation)\n- [Contributing](#contributing)\n- [API stability](#api-stability)\n- [License](#license)\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`feu` can be installed from pip using the following command:\n\n```shell\npip install feu\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `feu` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install feu[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/feu/get_started) to see how to\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `feu` versions and supported dependencies.\n\n| `feu` | `packaging` | `python` | `click`<sup>*</sup> |\n|---------|----------------|---------------|---------------------|\n| `main` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |\n| `0.3.1` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |\n| `0.3.0` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |\n| `0.2.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |\n| `0.2.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |\n| `0.2.2` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |\n| `0.2.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |\n| `0.2.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | `>=8.1,<9.0` |\n\n<sup>*</sup> indicates an optional dependency\n\n<details>\n <summary>older versions</summary>\n\n| `feu` | `packaging` | `python` | `click`<sup>*</sup> | `fire`<sup>*</sup> |\n|---------|----------------|---------------|---------------------|--------------------|\n| `0.1.1` | `>=21.0,<25.0` | `>=3.9,<3.13` | | `>=0.6.0,<1.0` |\n| `0.1.0` | `>=21.0,<25.0` | `>=3.9,<3.13` | | `>=0.6.0,<1.0` |\n| `0.0.7` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |\n| `0.0.6` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |\n| `0.0.5` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |\n| `0.0.4` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |\n| `0.0.3` | `>=21.0,<25.0` | `>=3.9,<3.13` | | |\n| `0.0.2` | `>=22.0,<24.0` | `>=3.9,<3.13` | | |\n| `0.0.1` | `>=22.0,<23.3` | `>=3.9,<3.13` | | |\n\n</details>\n\n## Contributing\n\nPlease check the instructions in [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n\n## Suggestions and Communication\n\nEveryone is welcome to contribute to the community.\nIf you have any questions or suggestions, you can\nsubmit [Github Issues](https://github.com/durandtibo/feu/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `feu` is in development stage, no API is guaranteed to be stable from one\nrelease to the next.\nIn fact, it is very likely that the API will change multiple times before a stable 1.0.0 release.\nIn practice, this means that upgrading `feu` to a new version will possibly break any code that\nwas using the old version of `feu`.\n\n## License\n\n`feu` is licensed under BSD 3-Clause \"New\" or \"Revised\" license available in [LICENSE](LICENSE)\nfile.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A light library to help to manage packages",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/durandtibo/feu",
"Repository": "https://github.com/durandtibo/feu"
},
"split_keywords": [
"package",
" install",
" dependency"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb1294a42212bc44866ff86c050ea625f05f30401c9275f42b3639813bc58b79",
"md5": "b26f9b2eaeb3d728c91906105d548dee",
"sha256": "ed425fc594d38a1e33af2d770ab353f1a2670e5d7a421b16b82e3293c745d27e"
},
"downloads": -1,
"filename": "feu-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b26f9b2eaeb3d728c91906105d548dee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 11394,
"upload_time": "2024-11-02T00:46:28",
"upload_time_iso_8601": "2024-11-02T00:46:28.035140Z",
"url": "https://files.pythonhosted.org/packages/cb/12/94a42212bc44866ff86c050ea625f05f30401c9275f42b3639813bc58b79/feu-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c3b951f3f9c92ecb3e296b525236e9046bb3d48b5b3fc62be17d544bec165b9",
"md5": "fc4f2fb300c90d6efeed08c1813be713",
"sha256": "4fba5cbf8ba8081d29ac4e9ecae05aae6001a55245f52b8b1c378f3098a6c716"
},
"downloads": -1,
"filename": "feu-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "fc4f2fb300c90d6efeed08c1813be713",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 12721,
"upload_time": "2024-11-02T00:46:29",
"upload_time_iso_8601": "2024-11-02T00:46:29.440236Z",
"url": "https://files.pythonhosted.org/packages/7c/3b/951f3f9c92ecb3e296b525236e9046bb3d48b5b3fc62be17d544bec165b9/feu-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 00:46:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "feu",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "feu"
}
JSON
