| Name | heatmap_cli JSON |
| Version |
0.12.3
JSON |
| download |
| home_page | None |
| Summary | A console program that generates yearly calendar heatmap. |
| upload_time | 2024-04-27 16:25:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| 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
```
```console
usage: heatmap [--demo [NUMBER_OF_COLORMAP]] [-yr YEAR] [-wk WEEK]
[-od OUTPUT_DIR] [-o] [-p] [-v] [-e] [-t TITLE]
[-f IMAGE_FORMAT] [-cm COLORMAP] [-cmin COLORMAP_MIN_VALUE]
[-cmax COLORMAP_MAX_VALUE] [-cb] [-a] [-q] [-Y] [-d] [-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
optional arguments:
--demo [NUMBER_OF_COLORMAP]
generate number of heatmaps by colormaps (default: '178')
-yr YEAR, --year YEAR
filter by year from the CSV file (default: '2024')
-wk WEEK, --week WEEK
filter until week of the year from the CSV file (default: '15')
-od 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
-e, --env
print environment information for bug reporting (default: 'False')
-t TITLE, --title TITLE
set title for the heatmap (default: 'False')
-f IMAGE_FORMAT, --format IMAGE_FORMAT
set the default image format(default: 'png')
-cm 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_heat, gist_heat_r
gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern, gist_stern_r
gist_yarg, gist_yarg_r, GnBu, GnBu_r, gnuplot, gnuplot2
gnuplot2_r, gnuplot_r, gray, gray_r, Greens, Greens_r
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
-cmin COLORMAP_MIN_VALUE, --cmap-min COLORMAP_MIN_VALUE
set the minimum value of the colormap range (default: 'False')
-cmax COLORMAP_MAX_VALUE, --cmap-max COLORMAP_MAX_VALUE
set the maximum value of the colormap range (default: 'False')
-cb, --cbar
show colorbar (default: 'False')
-a, --annotate
add count to each heatmap region (default: 'False')
-q, --quiet
suppress all logging
-Y, --yes
yes to prompt
-d, --debug
show debugging log and stacktrace
-V, --version
show program's version number and exit
-h, --help
show this help message and exit
```
## 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": null,
"maintainer_email": null,
"keywords": "heatmap, cli",
"author": null,
"author_email": "Kian-Meng Ang <kianmeng@cpan.org>",
"download_url": "https://files.pythonhosted.org/packages/8d/4b/14387561fb398af274393b0111413521696fb9c987bda6648ebd22e96253/heatmap_cli-0.12.3.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```console\nusage: heatmap [--demo [NUMBER_OF_COLORMAP]] [-yr YEAR] [-wk WEEK]\n [-od OUTPUT_DIR] [-o] [-p] [-v] [-e] [-t TITLE]\n [-f IMAGE_FORMAT] [-cm COLORMAP] [-cmin COLORMAP_MIN_VALUE]\n [-cmax COLORMAP_MAX_VALUE] [-cb] [-a] [-q] [-Y] [-d] [-V] [-h]\n CSV_FILENAME\n\nA console program that generates yearly calendar heatmap.\n\n website: https://github.com/kianmeng/heatmap_cli\n changelog: https://github.com/kianmeng/heatmap_cli/blob/master/CHANGELOG.md\n issues: https://github.com/kianmeng/heatmap_cli/issues\n\npositional arguments:\n CSV_FILENAME\n csv filename\n\noptional arguments:\n --demo [NUMBER_OF_COLORMAP]\n generate number of heatmaps by colormaps (default: '178')\n -yr YEAR, --year YEAR\n filter by year from the CSV file (default: '2024')\n -wk WEEK, --week WEEK\n filter until week of the year from the CSV file (default: '15')\n -od 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 -e, --env\n print environment information for bug reporting (default: 'False')\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 -cm 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_heat, gist_heat_r\n gist_ncar, gist_ncar_r, gist_rainbow, gist_rainbow_r, gist_stern, gist_stern_r\n gist_yarg, gist_yarg_r, GnBu, GnBu_r, gnuplot, gnuplot2\n gnuplot2_r, gnuplot_r, gray, gray_r, Greens, Greens_r\n Greys, Greys_r, hot, hot_r, hsv, hsv_r\n icefire, icefire_r, inferno, inferno_r, jet, jet_r\n magma, magma_r, mako, mako_r, nipy_spectral, nipy_spectral_r\n ocean, ocean_r, Oranges, Oranges_r, OrRd, OrRd_r\n Paired, Paired_r, Pastel1, Pastel1_r, Pastel2, Pastel2_r\n pink, pink_r, PiYG, PiYG_r, plasma, plasma_r\n PRGn, PRGn_r, prism, prism_r, PuBu, PuBu_r\n PuBuGn, PuBuGn_r, PuOr, PuOr_r, PuRd, PuRd_r\n Purples, Purples_r, rainbow, rainbow_r, RdBu, RdBu_r\n RdGy, RdGy_r, RdPu, RdPu_r, RdYlBu, RdYlBu_r\n RdYlGn, RdYlGn_r, Reds, Reds_r, rocket, rocket_r\n seismic, seismic_r, Set1, Set1_r, Set2, Set2_r\n Set3, Set3_r, Spectral, Spectral_r, spring, spring_r\n summer, summer_r, tab10, tab10_r, tab20, tab20_r\n tab20b, tab20b_r, tab20c, tab20c_r, terrain, terrain_r\n turbo, turbo_r, twilight, twilight_r, twilight_shifted, twilight_shifted_r\n viridis, viridis_r, vlag, vlag_r, winter, winter_r\n Wistia, Wistia_r, YlGn, YlGn_r, YlGnBu, YlGnBu_r\n YlOrBr, YlOrBr_r, YlOrRd, YlOrRd_r\n -cmin COLORMAP_MIN_VALUE, --cmap-min COLORMAP_MIN_VALUE\n set the minimum value of the colormap range (default: 'False')\n -cmax COLORMAP_MAX_VALUE, --cmap-max COLORMAP_MAX_VALUE\n set the maximum value of the colormap range (default: 'False')\n -cb, --cbar\n show colorbar (default: 'False')\n -a, --annotate\n add count to each heatmap region (default: 'False')\n -q, --quiet\n suppress all logging\n -Y, --yes\n yes to prompt\n -d, --debug\n show debugging log and stacktrace\n -V, --version\n show program's version number and exit\n -h, --help\n show this help message and exit\n```\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.12.3",
"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": "939baacf5ca9b25174d2616cc85a828b3528c2f3255388eed9b6d944f425f04d",
"md5": "7ee0f6ddf199e8b055cacab2299e9ea6",
"sha256": "1f20d6cc07c23ba28761e7c2d77d4ac857bb08913e342cd12a0571defbfef13c"
},
"downloads": -1,
"filename": "heatmap_cli-0.12.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ee0f6ddf199e8b055cacab2299e9ea6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 21426,
"upload_time": "2024-04-27T16:25:18",
"upload_time_iso_8601": "2024-04-27T16:25:18.147486Z",
"url": "https://files.pythonhosted.org/packages/93/9b/aacf5ca9b25174d2616cc85a828b3528c2f3255388eed9b6d944f425f04d/heatmap_cli-0.12.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8d4b14387561fb398af274393b0111413521696fb9c987bda6648ebd22e96253",
"md5": "a14bf1266e97e5c11cf8d648a5e99db2",
"sha256": "91dfe2edcaae711cc38d0ec307193d89276326d637749422d825d120255bbe24"
},
"downloads": -1,
"filename": "heatmap_cli-0.12.3.tar.gz",
"has_sig": false,
"md5_digest": "a14bf1266e97e5c11cf8d648a5e99db2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 91619,
"upload_time": "2024-04-27T16:25:24",
"upload_time_iso_8601": "2024-04-27T16:25:24.061675Z",
"url": "https://files.pythonhosted.org/packages/8d/4b/14387561fb398af274393b0111413521696fb9c987bda6648ebd22e96253/heatmap_cli-0.12.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 16:25:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kianmeng",
"github_project": "heatmap_cli",
"github_not_found": true,
"lcname": "heatmap_cli"
}
