heatmap_cli
A console program that generates yearly calendar heatmap.
Installation
Stable version From PyPI using pipx:
uv tool install heatmap_cli
Stable version From PyPI using pip:
uv tool upgrade heatmap_cli
Usage
heatmap -h -v
usage: heatmap_cli [--demo [NUMBER_OF_COLORMAP]] [--seed SEED] [-y YEAR]
[-w WEEK] [-e END_DATE] [-s START_DATE] [-O OUTPUT_DIR]
[-o] [-p] [-v] [-t TITLE] [-u AUTHOR] [-f IMAGE_FORMAT]
[-c COLORMAP] [-i COLORMAP_MIN_VALUE]
[-x COLORMAP_MAX_VALUE] [-b]
[-a | --annotate | --no-annotate] [--animate-by-week] [-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 (required unless --demo is used)
options:
--demo [NUMBER_OF_COLORMAP]
generate number of heatmaps by colormaps (default: '192')
--seed SEED
set random seed for reproducible --demo output (default: None)
-y YEAR, --year YEAR
filter by year from the CSV file (default: 'None')
-w WEEK, --week WEEK
filter until week of the year from the CSV file (default: current week)
-e END_DATE, --end-date END_DATE
filter until the date of the year from the CSV file and this will overwrite -y and -w option (default: None)
-s START_DATE, --start-date START_DATE
filter from the date of the year from the CSV file and this 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 the 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: None)
-u AUTHOR, --author AUTHOR
set author for the heatmap (default: kianmeng.org)
-f IMAGE_FORMAT, --format IMAGE_FORMAT
set the default image format (default: 'png')
-c COLORMAP, --cmap COLORMAP
Set default colormap. (default: 'RdYlGn_r')
Available colormaps:
Accent, Accent_r, afmhot, afmhot_r, autumn, autumn_r
berlin, berlin_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_grey_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
gist_yerg, gist_yerg_r, GnBu, GnBu_r, gnuplot, gnuplot2
gnuplot2_r, gnuplot_r, gray, gray_r, Grays, Grays_r
Greens, Greens_r, grey, grey_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, managua, managua_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
vanimo, vanimo_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: None)
-x COLORMAP_MAX_VALUE, --cmap-max COLORMAP_MAX_VALUE
Set the maximum value of the colormap range (default: None)
-b, --cbar
show colorbar (default: False)
-a, --annotate, --no-annotate
add count to each heatmap region (use --no-annotate to disable) (default: True)
--animate-by-week
create an animation for each day of the current week
-q, --quiet
suppress all logging
-Y, --yes
yes to prompt
-d, --debug
show debugging log and stack trace
-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.
1 maintainer
Metadata
1 maintainer
Release files for heatmap_cli 0.26.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| heatmap_cli-0.26.0.tar.gz | 45.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| heatmap_cli-0.26.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 79.2 kB
Release files / heatmap_cli-0.26.0.tar.gz
| Download URL | heatmap_cli-0.26.0.tar.gz |
|---|---|
| Size | 45.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bf7f07ad51baae6cc70ce7d8d180bdc71a27c10597db1809b0ca115385ec8c56
|
|
BLAKE2b-256 checksum How to use checksums |
0b8809375d5b95411d4e144a707fae79cead17092f69f36f5bf6aeef8a1bd087
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / heatmap_cli-0.26.0-py3-none-any.whl
| Download URL | heatmap_cli-0.26.0-py3-none-any.whl |
|---|---|
| Size | 33.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
19d7c2fd53cdf7d0ffaac03a05d3181121965cb986cf8578648c469e490e7875
|
|
BLAKE2b-256 checksum How to use checksums |
31714f0e8b615df1002e7e44fb8e54f02007058f5de73876b0b13a9a7a3731b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for heatmap_cli 0.26.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
