A console program that generates yearly calendar heatmap.
Project description
heatmap_cli
A console program that generates yearly calendar heatmap.
Installation
Stable version From PyPI using pipx
:
pipx install heatmap_cli
Stable version From PyPI using pip
:
python -m pip install heatmap_cli
Upgrade to latest stable version:
python3 -m pip install heatmap_cli --upgrade
Latest development version from GitHub:
python -m pip install -e git+https://github.com/kianmeng/heatmap_cli.git
Usage
heatmap -h -v
usage: heatmap_cli [--demo [NUMBER_OF_COLORMAP]] [-yr YEAR] [-wk WEEK]
[-od OUTPUT_DIR] [-o] [-p] [-v] [-t TITLE]
[-f IMAGE_FORMAT] [-cm COLORMAP] [-cmin COLORMAP_MIN_VALUE]
[-cmax COLORMAP_MAX_VALUE] [-cb] [-a] [-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')
-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: '32')
-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
-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_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
-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
-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
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) from https://commons.wikimedia.org/entity/M2787008.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for heatmap_cli-0.12.26-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8f04589d454b02d8530950a9e479021a98d0260097b29728e8196264b4b1869 |
|
MD5 | 5b6176a2ccf74b84ba24ec18bca4030e |
|
BLAKE2b-256 | da79215de262dca9325b39b0d954dcf0a76f7ed14407c931f512c7faeb3e6066 |