Skip to main content

A CLI tool to create punchard visualizations.

Project description

clipunch - a CLI tool to create punchard visualizations.

clipunch consumes data from stdin. It has to be comma-separated pairs of dates with frequencies. For example, piping the following data to clipunch creates a punchard visualization for the complete year 2022 printed to the terminal.

cat << EOF | clipunch
2022-10-25,3
2022-11-07,3
2022-11-08,1
2022-11-09,3
2022-11-28,1
2022-12-04,7
2022-12-05,1
2022-12-06,1
2022-12-07,5
2022-12-08,2
2022-12-14,21
EOF

In case data spans more than a year, multiple punchcard visualizations -one per year- are created in chronological order.

Note, the tools assumes that provided dates are unique. If multiple data values for a single date are given, only the last one is visualized.

Installation

pip install clipunch

Usage

clipunch [--html]

Options: --html Create punchcard as HTML file, which is open in browser.

Examples:

To plot the commit activity to the Spring Framework, clone the repository, create commit frequencies per day, and pip it to clipunch.

git clone https://github.com/spring-projects/spring-framework.git
git -C ./spring-framework/ log --date=short --pretty=format:%ad | \
    sort | uniq -c | awk '{print $2","$1}' | \
    clipunch --html

The output on the terminal will look similar to the following.

git -C ./spring-framework/ log --author "Juergen Hoeller" --date=short --pretty=format:%ad | \
    sort | uniq -c | awk '{print $2","$1}' | \
    clipunch --html

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clipunch-1.0.0.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

clipunch-1.0.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file clipunch-1.0.0.tar.gz.

File metadata

  • Download URL: clipunch-1.0.0.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-76051900-generic

File hashes

Hashes for clipunch-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0a8093d2d74129777cef1613ea85320d7fe1049ace7ec4d4f9790b0b399785c3
MD5 2909bb18b57161d11abe92706b8f208a
BLAKE2b-256 90d2bfea680d41f7eaa518313100e25a2b5a782f66f5551c7f77f4a4e998b502

See more details on using hashes here.

File details

Details for the file clipunch-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: clipunch-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-76051900-generic

File hashes

Hashes for clipunch-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a6cf110ae52dd4fb5c1c3b9deb0060748f3eba4295580a5b49db7304da128362
MD5 3e82eb1d88bd1b5a1c08411b47ff5dee
BLAKE2b-256 1129f4c6b06e93d4d7ca5d9419e131061e5f53d785f09d6f7aa343acdd08f280

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page