https://github.com/durandtibo/flamme
A library to generate custom reports of pandas DataFrames
https://github.com/durandtibo/flamme
Last synced: 2 months ago
JSON representation
A library to generate custom reports of pandas DataFrames
- Host: GitHub
- URL: https://github.com/durandtibo/flamme
- Owner: durandtibo
- License: bsd-3-clause
- Created: 2023-10-25T04:06:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T03:41:22.000Z (about 1 year ago)
- Last Synced: 2024-04-16T01:34:37.727Z (about 1 year ago)
- Language: Python
- Size: 1.48 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# flamme
/badge.svg)
/badge.svg)
A library to generate custom reports of pandas DataFrames
## Installation
We highly recommend installing
a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).
`flamme` can be installed from pip using the following command:
```shell
pip install flamme
```
To make the package as slim as possible, only the minimal packages required to use `flamme` are
installed.
To include all the dependencies, you can use the following command:
```shell
pip install flamme[all]
```
Please check the [get started page](https://durandtibo.github.io/flamme/get_started) to see how to
install only some specific dependencies or other alternatives to install the library.
The following is the corresponding `flamme` versions and their dependencies.
| `flamme` | `coola` | `grizz` | `iden` | `jinja2` | `matplotlib` | `numpy` | `objectory` | `polars` | `pyarrow` | `scipy` | `python` |
|----------|----------------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|---------------|
| `main` | `>=0.7.2,<1.0` | `>=0.1,<1.0` | `>=0.1,<1.0` | `>=3.0,<4.0` | `>=3.6,<4.0` | `>=1.23,<3.0` | `>=0.1,<1.0` | `>=1.0,<2.0` | `>=10.0,<19.0` | `>=1.10,<2.0` | `>=3.9,<3.13` |
Optional dependencies
| `flamme` | `clickhouse-connect`* | `colorlog`* | `hya`* | `markdown`* | `tqdm`* |
|----------|----------------------------------|------------------------|-------------------|------------------------|--------------------|
| `main` | `>=0.7,<1.0` | `>=6.7,<7.0` | `>=0.2,<1.0` | `>=3.4,<4.0` | `>=4.65,<5.0` |
older versions
| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |
|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|
| `0.0.16` | `>=0.2,<1.0` | `>=3.0,<4.0` | `>=3.4,<4.0` | `>=3.6,<4.0` | `>=1.23,<3.0` | `>=0.1,<1.0` | `>=1.4,<3.0` | `>=10.0,<17.0` | `>=1.10,<2.0` | `>=4.65,<5.0` | `>=3.9,<3.13` |
| `0.0.15` | `>=0.2,<1.0` | `>=3.0,<4.0` | `>=3.4,<4.0` | `>=3.6,<4.0` | `>=1.23,<3.0` | `>=0.1,<1.0` | `>=1.4,<3.0` | `>=10.0,<17.0` | `>=1.10,<2.0` | `>=4.65,<5.0` | `>=3.9,<3.13` |
| `0.0.14` | `>=0.2,<1.0` | `>=3.0,<4.0` | `>=3.4,<4,0` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<1.0` | `>=1.4,<3.0` | `>=10.0,<17.0` | `>=1.10,<2.0` | `>=4.65,<5.0` | `>=3.9,<3.13` |
| `0.0.13` | `>=0.2,<1.0` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.4,<3.0` | `>=10.0,<15.0` | `>=1.10,<2.0` | `>=4.65,<5.0` | `>=3.9,<3.13` |
| `0.0.12` | `>=0.2,<0.3` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.4,<3.0` | `>=10.0,<15.0` | `>=1.10,<2.0` | `>=4.65,<4.67` | `>=3.9,<3.13` |
| `0.0.11` | `>=0.2,<0.3` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.4,<3.0` | `>=10.0,<15.0` | `>=1.10,<2.0` | `>=4.65,<4.67` | `>=3.9,<3.13` |
| `0.0.10` | `>=0.2,<0.3` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.3,<2.2` | `>=10.0,<15.0` | `>=1.10,<2.0` | `>=4.65,<4.67` | `>=3.9,<3.13` |
| `0.0.9` | `>=0.2,<0.3` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.3,<2.2` | `>=10.0,<15.0` | `>=1.10,<2.0` | `>=4.65,<4.67` | `>=3.9,<3.13` |
| `0.0.8` | `>=0.2,<0.3` | `>=3.0,<3.2` | `>=3.4,<3.6` | `>=3.6,<4.0` | `>=1.23,<2.0` | `>=0.1,<0.2` | `>=1.3,<2.2` | `>=10.0,<15.0` | | `>=4.65,<4.67` | `>=3.9,<3.12` |
## 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/flamme/issues).
We will reply to you as soon as possible. Thank you very much.
## API stability
:warning: While `flamme` 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 `flamme` to a new version will possibly break any code that
was using the old version of `flamme`.
## License
`flamme` is licensed under BSD 3-Clause "New" or "Revised" license available in [LICENSE](LICENSE)
file.