An open API service indexing awesome lists of open source software.

https://github.com/durandtibo/feu

A light library to help to manage packages
https://github.com/durandtibo/feu

Last synced: 2 months ago
JSON representation

A light library to help to manage packages

Awesome Lists containing this project

README

        

# feu :fire:



CI


Nightly Tests


Nightly Package Tests




Documentation


Documentation




Codecov










Code style: black


Doc style: google


Ruff


Doc style: google




PYPI version


Python


BSD-3-Clause




Downloads


Monthly downloads



## 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`* |
|---------|----------------|---------------|---------------------|
| `main` | `>=21.0,<25.0` | `>=3.9,<3.14` | `>=8.1,<9.0` |
| `0.3.2` | `>=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` |

* indicates an optional dependency

older versions

| `feu` | `packaging` | `python` | `click`* | `fire`* |
|---------|----------------|---------------|---------------------|--------------------|
| `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` | | |

## 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.