# 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 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,<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.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` |
<details>
<summary>older versions</summary>
| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |
|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|
| `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` |
</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/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.
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/1c/48/f8520dbbae728a550c6a20dafda0d4c4bb3fb3f3e3720fd482d5e25a61ae/flamme-0.0.16.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 their dependencies.\n\n| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |\n|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|\n| `main` | `>=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` |\n| `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` |\n| `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` |\n| `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` |\n| `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` |\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\n<details>\n <summary>older versions</summary>\n\n| `flamme` | `coola` | `jinja2` | `markdown` | `matplotlib` | `numpy` | `objectory` | `pandas` | `pyarrow` | `scipy` | `tqdm` | `python` |\n|----------|--------------|--------------|--------------|--------------|---------------|--------------|--------------|----------------|---------------|----------------|---------------|\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\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/flamme/issues).\nWe will reply to you as soon as possible. Thank you very much.\n\n## API stability\n\n:warning: While `flamme` 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 `flamme` to a new version will possibly break any code that\nwas using the old version of `flamme`.\n\n## License\n\n`flamme` 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 library to generate custom reports of pandas DataFrames",
"version": "0.0.16",
"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": "48025f1d2c2d39634f29d64ebdf296d96a76006c950f1db858992f27b9c714f2",
"md5": "1ae06b87fabb29136540c0a2f84005e9",
"sha256": "8a6e666e60c78efd7698d8eb54f5506f861e27629afb613f7c520d2ccfc1ed54"
},
"downloads": -1,
"filename": "flamme-0.0.16-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ae06b87fabb29136540c0a2f84005e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 118196,
"upload_time": "2024-07-04T20:57:52",
"upload_time_iso_8601": "2024-07-04T20:57:52.487011Z",
"url": "https://files.pythonhosted.org/packages/48/02/5f1d2c2d39634f29d64ebdf296d96a76006c950f1db858992f27b9c714f2/flamme-0.0.16-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1c48f8520dbbae728a550c6a20dafda0d4c4bb3fb3f3e3720fd482d5e25a61ae",
"md5": "5710ff2326062af3b90baabf7f4b5a99",
"sha256": "70335385ec31907d101acec999fb2dba89ae8edb39cd71dc46e2240649fdc176"
},
"downloads": -1,
"filename": "flamme-0.0.16.tar.gz",
"has_sig": false,
"md5_digest": "5710ff2326062af3b90baabf7f4b5a99",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 57553,
"upload_time": "2024-07-04T20:57:54",
"upload_time_iso_8601": "2024-07-04T20:57:54.433442Z",
"url": "https://files.pythonhosted.org/packages/1c/48/f8520dbbae728a550c6a20dafda0d4c4bb3fb3f3e3720fd482d5e25a61ae/flamme-0.0.16.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-04 20:57:54",
"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
