Skip to main content

A library to generate custom reports of pandas DataFrames

Project description

flamme

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

A library to generate custom reports of pandas DataFrames

Installation

We highly recommend installing a virtual environment. flamme can be installed from pip using the following command:

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:

pip install flamme[all]

Please check the get started page 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 jinja2 markdown matplotlib numpy objectory pandas pyarrow scipy tqdm python
main >=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.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.

Suggestions and Communication

Everyone is welcome to contribute to the community. If you have any questions or suggestions, you can submit Github 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 file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flamme-0.0.14.tar.gz (57.2 kB view hashes)

Uploaded Source

Built Distribution

flamme-0.0.14-py3-none-any.whl (117.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page