Metadata-Version: 2.1
Name: heatmap_cli
Version: 0.4.4
Summary: A console program that generates yearly calendar heatmap.
Keywords: heatmap,cli
Author-email: Kian-Meng Ang <kianmeng@cpan.org>
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: seaborn
Project-URL: Changelog, https://github.com/kianmeng/heatmap_cli/blob/master/CHANGELOG.md
Project-URL: Issues, https://github.com/kianmeng/heatmap_cli/issues
Project-URL: Source, https://github.com/kianmeng/heatmap_cli

# 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
```

Latest development version from GitHub:

```console
python -m pip install -e git+https://github.com/kianmeng/heatmap_cli.git
```

## Usage

```console
heatmap_cli -h -v
```

```console
usage: heatmap_cli [--demo] [-yr YEAR] [-wk WEEK] [-od OUTPUT_DIR] [-v]
                   [-cm COLORMAP] [-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
      generate all heatmaps by colormaps
  -yr YEAR, --year YEAR
      filter by year from the CSV file (default: '2023')
  -wk WEEK, --week WEEK
      filter until week of the year from the CSV file (default: '35')
  -od OUTPUT_DIR, --output-dir OUTPUT_DIR
      set default output folder (default: 'output')
  -v, --verbose
      show verbosity of debugging log, use -vv, -vvv for more details
  -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
  -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 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>.

