| Name | heatmap_cli JSON |
| Version |
0.16.5
JSON |
| download |
| home_page | None |
| Summary | A console program that generates yearly calendar heatmap. |
| upload_time | 2025-02-23 07:24:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
heatmap
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# heatmap_cli
A console program that generates yearly calendar heatmap.
## Installation
Stable version From PyPI using `pipx`:
```console
pipx install heatmap_cli
```
Stable version From PyPI using `pip`:
```console
python -m pip install heatmap_cli
```
Upgrade to latest stable version:
```console
python3 -m pip install heatmap_cli --upgrade
```
Latest development version from GitHub:
```console
python -m pip install -e git+https://github.com/kianmeng/heatmap_cli.git
```
## Usage
```console
heatmap -h -v
```
<!--help !-->
```console
usage: heatmap_cli [--demo [NUMBER_OF_COLORMAP]] [-y YEAR] [-w WEEK]
[-e END_DATE] [-O OUTPUT_DIR] [-o] [-p] [-v] [-t TITLE]
[-f IMAGE_FORMAT] [-c COLORMAP] [-i COLORMAP_MIN_VALUE]
[-x COLORMAP_MAX_VALUE] [-b]
[-a | --annotate | --no-annotate] [-q] [-Y] [-d] [-E] [-V]
[-h]
CSV_FILENAME
A console program that generates yearly calendar heatmap.
website: https://github.com/kianmeng/heatmap_cli
changelog: https://github.com/kianmeng/heatmap_cli/blob/master/CHANGELOG.md
issues: https://github.com/kianmeng/heatmap_cli/issues
positional arguments:
CSV_FILENAME
csv filename
options:
--demo [NUMBER_OF_COLORMAP]
generate number of heatmaps by colormaps (default: '182')
-y YEAR, --year YEAR
filter by year from the CSV file (default: '2025')
-w WEEK, --week WEEK
filter until week of the year from the CSV file (default: '8')
-e END_DATE, --end-date END_DATE
filter until the date of the year from the CSV file, will overwrite -y and -w option (default: None)
-O OUTPUT_DIR, --output-dir OUTPUT_DIR
set default output folder (default: 'output')
-o, --open
open the generated heatmap using default program (default: False)
-p, --purge
remove all leftover artifacts set by --output-dir folder (default: False)
-v, --verbose
show verbosity of debugging log, use -vv, -vvv for more details
-t TITLE, --title TITLE
set title for the heatmap (default: False)
-f IMAGE_FORMAT, --format IMAGE_FORMAT
set the default image format(default: 'png')
-c COLORMAP, --cmap COLORMAP
set default colormap (default: 'RdYlGn_r')
Accent, Accent_r, afmhot, afmhot_r, autumn, autumn_r
binary, binary_r, Blues, Blues_r, bone, bone_r
BrBG, BrBG_r, brg, brg_r, BuGn, BuGn_r
BuPu, BuPu_r, bwr, bwr_r, cividis, cividis_r
CMRmap, CMRmap_r, cool, cool_r, coolwarm, coolwarm_r
copper, copper_r, crest, crest_r, cubehelix, cubehelix_r
Dark2, Dark2_r, flag, flag_r, flare, flare_r
gist_earth, gist_earth_r, gist_gray, gist_gray_r, gist_grey, gist_heat
gist_heat_r, gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern
gist_stern_r, gist_yarg, gist_yarg_r, gist_yerg, GnBu, GnBu_r
gnuplot, gnuplot2, gnuplot2_r, gnuplot_r, gray, gray_r
Grays, Greens, Greens_r, grey, Greys, Greys_r
hot, hot_r, hsv, hsv_r, icefire, icefire_r
inferno, inferno_r, jet, jet_r, magma, magma_r
mako, mako_r, nipy_spectral, nipy_spectral_r, ocean, ocean_r
Oranges, Oranges_r, OrRd, OrRd_r, Paired, Paired_r
Pastel1, Pastel1_r, Pastel2, Pastel2_r, pink, pink_r
PiYG, PiYG_r, plasma, plasma_r, PRGn, PRGn_r
prism, prism_r, PuBu, PuBu_r, PuBuGn, PuBuGn_r
PuOr, PuOr_r, PuRd, PuRd_r, Purples, Purples_r
rainbow, rainbow_r, RdBu, RdBu_r, RdGy, RdGy_r
RdPu, RdPu_r, RdYlBu, RdYlBu_r, RdYlGn, RdYlGn_r
Reds, Reds_r, rocket, rocket_r, seismic, seismic_r
Set1, Set1_r, Set2, Set2_r, Set3, Set3_r
Spectral, Spectral_r, spring, spring_r, summer, summer_r
tab10, tab10_r, tab20, tab20_r, tab20b, tab20b_r
tab20c, tab20c_r, terrain, terrain_r, turbo, turbo_r
twilight, twilight_r, twilight_shifted, twilight_shifted_r, viridis, viridis_r
vlag, vlag_r, winter, winter_r, Wistia, Wistia_r
YlGn, YlGn_r, YlGnBu, YlGnBu_r, YlOrBr, YlOrBr_r
YlOrRd, YlOrRd_r
-i COLORMAP_MIN_VALUE, --cmap-min COLORMAP_MIN_VALUE
set the minimum value of the colormap range (default: False)
-x COLORMAP_MAX_VALUE, --cmap-max COLORMAP_MAX_VALUE
set the maximum value of the colormap range (default: False)
-b, --cbar
show colorbar (default: False)
-a, --annotate, --no-annotate
add count to each heatmap region
-q, --quiet
suppress all logging
-Y, --yes
yes to prompt
-d, --debug
show debugging log and stacktrace
-E, --env
print environment information for bug reporting
-V, --version
show program's version number and exit
-h, --help
show this help message and exit
```
<!--help !-->
## Copyright and License
Copyright (C) 2023,2024 Kian-Meng Ang
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along
with this program. If not, see <https://www.gnu.org/licenses/>.
The fish logo used in the documentation generated by Sphinx is a public domain
drawing of male freshwater phase [Steelhead (Oncorhynchus
mykiss)](https://en.wikipedia.org/w/index.php?oldid=1147106962) from
<https://commons.wikimedia.org/entity/M2787008>.
Raw data
{
"_id": null,
"home_page": null,
"name": "heatmap_cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "heatmap, cli",
"author": null,
"author_email": "Kian-Meng Ang <kianmeng@cpan.org>",
"download_url": "https://files.pythonhosted.org/packages/e9/18/c55936e48217a33040a6be758deeac74d2e6ed9af1d85d73a61adc256296/heatmap_cli-0.16.5.tar.gz",
"platform": null,
"description": "# heatmap_cli\n\nA console program that generates yearly calendar heatmap.\n\n## Installation\n\nStable version From PyPI using `pipx`:\n\n```console\npipx install heatmap_cli\n```\n\nStable version From PyPI using `pip`:\n\n```console\npython -m pip install heatmap_cli\n```\n\nUpgrade to latest stable version:\n\n```console\npython3 -m pip install heatmap_cli --upgrade\n```\n\nLatest development version from GitHub:\n\n```console\npython -m pip install -e git+https://github.com/kianmeng/heatmap_cli.git\n```\n\n## Usage\n\n```console\nheatmap -h -v\n```\n\n<!--help !-->\n\n```console\nusage: heatmap_cli [--demo [NUMBER_OF_COLORMAP]] [-y YEAR] [-w WEEK]\n [-e END_DATE] [-O OUTPUT_DIR] [-o] [-p] [-v] [-t TITLE]\n [-f IMAGE_FORMAT] [-c COLORMAP] [-i COLORMAP_MIN_VALUE]\n [-x COLORMAP_MAX_VALUE] [-b]\n [-a | --annotate | --no-annotate] [-q] [-Y] [-d] [-E] [-V]\n [-h]\n CSV_FILENAME\n\nA console program that generates yearly calendar heatmap.\n\nwebsite: https://github.com/kianmeng/heatmap_cli\nchangelog: https://github.com/kianmeng/heatmap_cli/blob/master/CHANGELOG.md\nissues: https://github.com/kianmeng/heatmap_cli/issues\n\npositional arguments:\n CSV_FILENAME\n csv filename\n\noptions:\n --demo [NUMBER_OF_COLORMAP]\n generate number of heatmaps by colormaps (default: '182')\n -y YEAR, --year YEAR\n filter by year from the CSV file (default: '2025')\n -w WEEK, --week WEEK\n filter until week of the year from the CSV file (default: '8')\n -e END_DATE, --end-date END_DATE\n filter until the date of the year from the CSV file, will overwrite -y and -w option (default: None)\n -O OUTPUT_DIR, --output-dir OUTPUT_DIR\n set default output folder (default: 'output')\n -o, --open\n open the generated heatmap using default program (default: False)\n -p, --purge\n remove all leftover artifacts set by --output-dir folder (default: False)\n -v, --verbose\n show verbosity of debugging log, use -vv, -vvv for more details\n -t TITLE, --title TITLE\n set title for the heatmap (default: False)\n -f IMAGE_FORMAT, --format IMAGE_FORMAT\n set the default image format(default: 'png')\n -c COLORMAP, --cmap COLORMAP\n set default colormap (default: 'RdYlGn_r')\n Accent, Accent_r, afmhot, afmhot_r, autumn, autumn_r\n binary, binary_r, Blues, Blues_r, bone, bone_r\n BrBG, BrBG_r, brg, brg_r, BuGn, BuGn_r\n BuPu, BuPu_r, bwr, bwr_r, cividis, cividis_r\n CMRmap, CMRmap_r, cool, cool_r, coolwarm, coolwarm_r\n copper, copper_r, crest, crest_r, cubehelix, cubehelix_r\n Dark2, Dark2_r, flag, flag_r, flare, flare_r\n gist_earth, gist_earth_r, gist_gray, gist_gray_r, gist_grey, gist_heat\n gist_heat_r, gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern\n gist_stern_r, gist_yarg, gist_yarg_r, gist_yerg, GnBu, GnBu_r\n gnuplot, gnuplot2, gnuplot2_r, gnuplot_r, gray, gray_r\n Grays, Greens, Greens_r, grey, Greys, Greys_r\n hot, hot_r, hsv, hsv_r, icefire, icefire_r\n inferno, inferno_r, jet, jet_r, magma, magma_r\n mako, mako_r, nipy_spectral, nipy_spectral_r, ocean, ocean_r\n Oranges, Oranges_r, OrRd, OrRd_r, Paired, Paired_r\n Pastel1, Pastel1_r, Pastel2, Pastel2_r, pink, pink_r\n PiYG, PiYG_r, plasma, plasma_r, PRGn, PRGn_r\n prism, prism_r, PuBu, PuBu_r, PuBuGn, PuBuGn_r\n PuOr, PuOr_r, PuRd, PuRd_r, Purples, Purples_r\n rainbow, rainbow_r, RdBu, RdBu_r, RdGy, RdGy_r\n RdPu, RdPu_r, RdYlBu, RdYlBu_r, RdYlGn, RdYlGn_r\n Reds, Reds_r, rocket, rocket_r, seismic, seismic_r\n Set1, Set1_r, Set2, Set2_r, Set3, Set3_r\n Spectral, Spectral_r, spring, spring_r, summer, summer_r\n tab10, tab10_r, tab20, tab20_r, tab20b, tab20b_r\n tab20c, tab20c_r, terrain, terrain_r, turbo, turbo_r\n twilight, twilight_r, twilight_shifted, twilight_shifted_r, viridis, viridis_r\n vlag, vlag_r, winter, winter_r, Wistia, Wistia_r\n YlGn, YlGn_r, YlGnBu, YlGnBu_r, YlOrBr, YlOrBr_r\n YlOrRd, YlOrRd_r\n -i COLORMAP_MIN_VALUE, --cmap-min COLORMAP_MIN_VALUE\n set the minimum value of the colormap range (default: False)\n -x COLORMAP_MAX_VALUE, --cmap-max COLORMAP_MAX_VALUE\n set the maximum value of the colormap range (default: False)\n -b, --cbar\n show colorbar (default: False)\n -a, --annotate, --no-annotate\n add count to each heatmap region\n -q, --quiet\n suppress all logging\n -Y, --yes\n yes to prompt\n -d, --debug\n show debugging log and stacktrace\n -E, --env\n print environment information for bug reporting\n -V, --version\n show program's version number and exit\n -h, --help\n show this help message and exit\n```\n\n<!--help !-->\n\n## Copyright and License\n\nCopyright (C) 2023,2024 Kian-Meng Ang\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU Affero General Public License as published by the Free\nSoftware Foundation, either version 3 of the License, or (at your option) any\nlater version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License along\nwith this program. If not, see <https://www.gnu.org/licenses/>.\n\nThe fish logo used in the documentation generated by Sphinx is a public domain\ndrawing of male freshwater phase [Steelhead (Oncorhynchus\nmykiss)](https://en.wikipedia.org/w/index.php?oldid=1147106962) from\n<https://commons.wikimedia.org/entity/M2787008>.\n",
"bugtrack_url": null,
"license": null,
"summary": "A console program that generates yearly calendar heatmap.",
"version": "0.16.5",
"project_urls": {
"Changelog": "https://github.com/kianmeng/heatmap_cli/blob/master/CHANGELOG.md",
"Issues": "https://github.com/kianmeng/heatmap_cli/issues",
"Source": "https://github.com/kianmeng/heatmap_cli"
},
"split_keywords": [
"heatmap",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aa4ba3d187afa55daa64033aa69389805ffa0da02a66cd66c7b9ee7c524e1b99",
"md5": "1089e26e09c232d72e4d9eeb597f7582",
"sha256": "eb7455e5efaf4f4502047f12c2cd518ee5db5ac99e64771387c85958bf4c4aab"
},
"downloads": -1,
"filename": "heatmap_cli-0.16.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1089e26e09c232d72e4d9eeb597f7582",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 23612,
"upload_time": "2025-02-23T07:24:05",
"upload_time_iso_8601": "2025-02-23T07:24:05.913210Z",
"url": "https://files.pythonhosted.org/packages/aa/4b/a3d187afa55daa64033aa69389805ffa0da02a66cd66c7b9ee7c524e1b99/heatmap_cli-0.16.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e918c55936e48217a33040a6be758deeac74d2e6ed9af1d85d73a61adc256296",
"md5": "d2546934df7218d80b1965c7b2b67ddf",
"sha256": "91dc26dbd9345b6abd31c7c46088f2bcf9ebffab6d44e555260bbd65f6f65670"
},
"downloads": -1,
"filename": "heatmap_cli-0.16.5.tar.gz",
"has_sig": false,
"md5_digest": "d2546934df7218d80b1965c7b2b67ddf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 103510,
"upload_time": "2025-02-23T07:24:08",
"upload_time_iso_8601": "2025-02-23T07:24:08.924388Z",
"url": "https://files.pythonhosted.org/packages/e9/18/c55936e48217a33040a6be758deeac74d2e6ed9af1d85d73a61adc256296/heatmap_cli-0.16.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 07:24:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kianmeng",
"github_project": "heatmap_cli",
"github_not_found": true,
"lcname": "heatmap_cli"
}
