# flamme
<p align="center">
<a href="https://github.com/durandtibo/flamme/actions">
<img alt="CI" src="https://github.com/durandtibo/flamme/workflows/CI/badge.svg">
</a>
<a href="https://github.com/durandtibo/flamme/actions">
<img alt="Nightly Tests" src="https://github.com/durandtibo/flamme/workflows/Nightly%20Tests/badge.svg">
</a>
<a href="https://github.com/durandtibo/flamme/actions">
<img alt="Nightly Package Tests" src="https://github.com/durandtibo/flamme/workflows/Nightly%20Package%20Tests/badge.svg">
</a>
<br/>
<a href="https://durandtibo.github.io/flamme/">
<img alt="Documentation" src="https://github.com/durandtibo/flamme/workflows/Documentation%20(stable)/badge.svg">
</a>
<a href="https://durandtibo.github.io/flamme/">
<img alt="Documentation" src="https://github.com/durandtibo/flamme/workflows/Documentation%20(unstable)/badge.svg">
</a>
<br/>
<a href="https://codecov.io/gh/durandtibo/flamme">
<img alt="Codecov" src="https://codecov.io/gh/durandtibo/flamme/branch/main/graph/badge.svg">
</a>
<a href="https://codeclimate.com/github/durandtibo/flamme/maintainability">
<img src="https://api.codeclimate.com/v1/badges/b124c0a1a64ee041e189/maintainability" />
</a>
<a href="https://codeclimate.com/github/durandtibo/flamme/test_coverage">
<img src="https://api.codeclimate.com/v1/badges/b124c0a1a64ee041e189/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/flamme/">
<img alt="PYPI version" src="https://img.shields.io/pypi/v/flamme">
</a>
<a href="https://pypi.org/project/flamme/">
<img alt="Python" src="https://img.shields.io/pypi/pyversions/flamme.svg">
</a>
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img alt="BSD-3-Clause" src="https://img.shields.io/pypi/l/flamme">
</a>
<br/>
<a href="https://pepy.tech/project/flamme">
<img alt="Downloads" src="https://static.pepy.tech/badge/flamme">
</a>
<a href="https://pepy.tech/project/flamme">
<img alt="Monthly downloads" src="https://static.pepy.tech/badge/flamme/month">
</a>
<br/>
</p>
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 tested dependencies.
| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |
|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|
| `main` | `>=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` |
Raw data
{
"_id": null,
"home_page": "https://github.com/durandtibo/flamme",
"name": "flamme",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "pandas, analysis, report",
"author": "Thibaut Durand",
"author_email": "durand.tibo+gh@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a7/96/38e8f6ca29f1920f0b11ed2e2e318e7648d14c7f3d7c0af68ac546db7ea9/flamme-0.0.13.tar.gz",
"platform": null,
"description": "# flamme\n\n<p align=\"center\">\n <a href=\"https://github.com/durandtibo/flamme/actions\">\n <img alt=\"CI\" src=\"https://github.com/durandtibo/flamme/workflows/CI/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/flamme/actions\">\n <img alt=\"Nightly Tests\" src=\"https://github.com/durandtibo/flamme/workflows/Nightly%20Tests/badge.svg\">\n </a>\n <a href=\"https://github.com/durandtibo/flamme/actions\">\n <img alt=\"Nightly Package Tests\" src=\"https://github.com/durandtibo/flamme/workflows/Nightly%20Package%20Tests/badge.svg\">\n </a>\n <br/>\n <a href=\"https://durandtibo.github.io/flamme/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/flamme/workflows/Documentation%20(stable)/badge.svg\">\n </a>\n <a href=\"https://durandtibo.github.io/flamme/\">\n <img alt=\"Documentation\" src=\"https://github.com/durandtibo/flamme/workflows/Documentation%20(unstable)/badge.svg\">\n </a>\n <br/>\n <a href=\"https://codecov.io/gh/durandtibo/flamme\">\n <img alt=\"Codecov\" src=\"https://codecov.io/gh/durandtibo/flamme/branch/main/graph/badge.svg\">\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/flamme/maintainability\">\n <img src=\"https://api.codeclimate.com/v1/badges/b124c0a1a64ee041e189/maintainability\" />\n </a>\n <a href=\"https://codeclimate.com/github/durandtibo/flamme/test_coverage\">\n <img src=\"https://api.codeclimate.com/v1/badges/b124c0a1a64ee041e189/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/flamme/\">\n <img alt=\"PYPI version\" src=\"https://img.shields.io/pypi/v/flamme\">\n </a>\n <a href=\"https://pypi.org/project/flamme/\">\n <img alt=\"Python\" src=\"https://img.shields.io/pypi/pyversions/flamme.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/flamme\">\n </a>\n <br/>\n <a href=\"https://pepy.tech/project/flamme\">\n <img alt=\"Downloads\" src=\"https://static.pepy.tech/badge/flamme\">\n </a>\n <a href=\"https://pepy.tech/project/flamme\">\n <img alt=\"Monthly downloads\" src=\"https://static.pepy.tech/badge/flamme/month\">\n </a>\n <br/>\n</p>\n\nA library to generate custom reports of pandas DataFrames\n\n## Installation\n\nWe highly recommend installing\na [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).\n`flamme` can be installed from pip using the following command:\n\n```shell\npip install flamme\n```\n\nTo make the package as slim as possible, only the minimal packages required to use `flamme` are\ninstalled.\nTo include all the dependencies, you can use the following command:\n\n```shell\npip install flamme[all]\n```\n\nPlease check the [get started page](https://durandtibo.github.io/flamme/get_started) to see how to\ninstall only some specific dependencies or other alternatives to install the library.\nThe following is the corresponding `flamme` versions and tested dependencies.\n\n| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |\n|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|\n| `main` | `>=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` |\n| `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` |\n| `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` |\n| `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` |\n| `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` |\n| `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` |\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A library to generate custom reports of pandas DataFrames",
"version": "0.0.13",
"project_urls": {
"Homepage": "https://github.com/durandtibo/flamme",
"Repository": "https://github.com/durandtibo/flamme"
},
"split_keywords": [
"pandas",
" analysis",
" report"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "296b62fb415d2c2a9ad02d3383b094e7bd01bfe686bebfe05de762792e84e7ab",
"md5": "642c67ae9d64794ff3a6274a6d5eb5b0",
"sha256": "a7b34b996c53efb4b3bfc63a6feac50c039e3395010264c0cff8aed7600fa6c5"
},
"downloads": -1,
"filename": "flamme-0.0.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "642c67ae9d64794ff3a6274a6d5eb5b0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 110467,
"upload_time": "2024-04-24T18:43:17",
"upload_time_iso_8601": "2024-04-24T18:43:17.886992Z",
"url": "https://files.pythonhosted.org/packages/29/6b/62fb415d2c2a9ad02d3383b094e7bd01bfe686bebfe05de762792e84e7ab/flamme-0.0.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a79638e8f6ca29f1920f0b11ed2e2e318e7648d14c7f3d7c0af68ac546db7ea9",
"md5": "2a31bb93695a1b64f1ef41d1fa1320bb",
"sha256": "7e3cf66e78c648a13dcc6072538b1833d96daea99622074e7583069f1f5d106e"
},
"downloads": -1,
"filename": "flamme-0.0.13.tar.gz",
"has_sig": false,
"md5_digest": "2a31bb93695a1b64f1ef41d1fa1320bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 53312,
"upload_time": "2024-04-24T18:43:19",
"upload_time_iso_8601": "2024-04-24T18:43:19.939673Z",
"url": "https://files.pythonhosted.org/packages/a7/96/38e8f6ca29f1920f0b11ed2e2e318e7648d14c7f3d7c0af68ac546db7ea9/flamme-0.0.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 18:43:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "durandtibo",
"github_project": "flamme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flamme"
}
JSON
