heatmap_cli


Nameheatmap_cli JSON
Version 0.19.7 PyPI version JSON
download
home_pageNone
SummaryA console program that generates a yearly calendar heatmap.
upload_time2025-07-13 09:21:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
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
uv tool install heatmap_cli
```

Stable version From PyPI using `pip`:

```console
uv tool upgrade heatmap_cli
```

## 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]
                   [-u AUTHOR] [-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 a 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')
  -y, --year YEAR
      filter by year from the CSV file (default: '2025')
  -w, --week WEEK
      filter until week of the year from the CSV file (default: '28')
  -e, --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)
  -O, --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
      set title for the heatmap (default: None)
  -u, --author AUTHOR
      set author for the heatmap (default: kianmeng.org)
  -f, --format IMAGE_FORMAT
      set the default image format (default: 'png')
  -c, --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, --cmap-min COLORMAP_MIN_VALUE
      Set the minimum value of the colormap range (default: None)
  -x, --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
  -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.
```

<!--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/e7/9b/c752eeb35eecd3cd2fab55097ade66e20fa569d20004ce5b630e355e6220/heatmap_cli-0.19.7.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\nuv tool install heatmap_cli\n```\n\nStable version From PyPI using `pip`:\n\n```console\nuv tool upgrade heatmap_cli\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                   [-u AUTHOR] [-f IMAGE_FORMAT] [-c COLORMAP]\n                   [-i COLORMAP_MIN_VALUE] [-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 a 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 (required unless --demo is used)\n\noptions:\n  --demo [NUMBER_OF_COLORMAP]\n      generate number of heatmaps by colormaps (default: '192')\n  -y, --year YEAR\n      filter by year from the CSV file (default: '2025')\n  -w, --week WEEK\n      filter until week of the year from the CSV file (default: '28')\n  -e, --end-date END_DATE\n      filter until the date of the year from the CSV file and this will overwrite -y and -w option (default: None)\n  -O, --output-dir OUTPUT_DIR\n      set default output folder (default: 'output')\n  -o, --open\n      open the generated heatmap using the 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\n      set title for the heatmap (default: None)\n  -u, --author AUTHOR\n      set author for the heatmap (default: kianmeng.org)\n  -f, --format IMAGE_FORMAT\n      set the default image format (default: 'png')\n  -c, --cmap COLORMAP\n      Set default colormap. (default: 'RdYlGn_r')\n\n      Available colormaps:\n        Accent, Accent_r, afmhot, afmhot_r, autumn, autumn_r\n        berlin, berlin_r, binary, binary_r, Blues, Blues_r\n        bone, bone_r, BrBG, BrBG_r, brg, brg_r\n        BuGn, BuGn_r, BuPu, BuPu_r, bwr, bwr_r\n        cividis, cividis_r, CMRmap, CMRmap_r, cool, cool_r\n        coolwarm, coolwarm_r, copper, copper_r, crest, crest_r\n        cubehelix, cubehelix_r, Dark2, Dark2_r, flag, flag_r\n        flare, flare_r, gist_earth, gist_earth_r, gist_gray, gist_gray_r\n        gist_grey, gist_grey_r, gist_heat, gist_heat_r, gist_ncar, gist_ncar_r\n        gist_rainbow, gist_rainbow_r, gist_stern, gist_stern_r, gist_yarg, gist_yarg_r\n        gist_yerg, gist_yerg_r, GnBu, GnBu_r, gnuplot, gnuplot2\n        gnuplot2_r, gnuplot_r, gray, gray_r, Grays, Grays_r\n        Greens, Greens_r, grey, grey_r, 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, managua, managua_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        vanimo, vanimo_r, viridis, viridis_r, vlag, vlag_r\n        winter, winter_r, Wistia, Wistia_r, YlGn, YlGn_r\n        YlGnBu, YlGnBu_r, YlOrBr, YlOrBr_r, YlOrRd, YlOrRd_r\n  -i, --cmap-min COLORMAP_MIN_VALUE\n      Set the minimum value of the colormap range (default: None)\n  -x, --cmap-max COLORMAP_MAX_VALUE\n      Set the maximum value of the colormap range (default: None)\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 stack trace\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\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A console program that generates a yearly calendar heatmap.",
    "version": "0.19.7",
    "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": "c98c33e5febc480b8f843266be8a2d4975eae7836aba7ed6cf4221790df789a9",
                "md5": "2f409bc06cb44402b2332b6bbc42df28",
                "sha256": "7a714dea9b644e9b1ba27418140d7ddc2550a129ecb6c68288fbed57832fa565"
            },
            "downloads": -1,
            "filename": "heatmap_cli-0.19.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2f409bc06cb44402b2332b6bbc42df28",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 366845,
            "upload_time": "2025-07-13T09:21:44",
            "upload_time_iso_8601": "2025-07-13T09:21:44.767472Z",
            "url": "https://files.pythonhosted.org/packages/c9/8c/33e5febc480b8f843266be8a2d4975eae7836aba7ed6cf4221790df789a9/heatmap_cli-0.19.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e79bc752eeb35eecd3cd2fab55097ade66e20fa569d20004ce5b630e355e6220",
                "md5": "221b3e0e0093231cde886a032e5249b9",
                "sha256": "e7e5ee9350ec7a6d3653f87c1bfa8b2139827f507dfc1c0a8d1c075ff29abcba"
            },
            "downloads": -1,
            "filename": "heatmap_cli-0.19.7.tar.gz",
            "has_sig": false,
            "md5_digest": "221b3e0e0093231cde886a032e5249b9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 365912,
            "upload_time": "2025-07-13T09:21:47",
            "upload_time_iso_8601": "2025-07-13T09:21:47.857796Z",
            "url": "https://files.pythonhosted.org/packages/e7/9b/c752eeb35eecd3cd2fab55097ade66e20fa569d20004ce5b630e355e6220/heatmap_cli-0.19.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-13 09:21:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kianmeng",
    "github_project": "heatmap_cli",
    "github_not_found": true,
    "lcname": "heatmap_cli"
}
        
Elapsed time: 1.46247s