Skip to main content

A digital clock made in Python for the terminal, inspired by tty-clock and tock.

Project description

pTock

A digital clock for the terminal, inspired by tty-clock and tock. The main difference with this version is that it is written in Python, and my goal was primarily to learn as much as possible about the language itself.

Note: emulating all the features of tty-clock and tock is not a goal of this project.

Features

  • Efficient bitmap and diff-based drawing.
  • Timezone fetched fro mthe system using the timedatectl command 2.
  • Military time and second display toggling.
  • Color customization.
  • Positioned or centered clock.
  • Adjustable display size.
  • Synchronization with system clock seconds.
  • Do not require any particular Python library, only standard Python libs.
  • If the terminal size changed, it will adjusts the clock position automatically.

Installation and Dependencies

  1. The only requirement is to have Python 3 installed and the basic core libraries.

  2. It is already available in PyPi, so you only need to run pip to intall and ptock to start the clock, as below:

pip install python3-ptock
ptock -h

Usage

Usage: ptock [OPTIONS]

A digital clock for the terminal.

Options:
  -h, --help             show this help message and exit
  -x, --x <X>            Horizontal 0-indexed position of top-left corner [default: 0]
  -y, --y <Y>            Vertical 0-indexed position of top-left corner [default: 0]
  -W, --width <WIDTH>    Font width in characters per tile [default: 2]
  -H, --height <HEIGHT>  Font height in characters per tile [default: 1]
  -s, --second           Display seconds
  -m, --military         Display military (24-hour) time
  -c, --center           Center the clock in the terminal. Overrides manual positioning
  -C, --color <COLOR>    Change the color of the time [If none is given, random from 1 to 7].

Available commands with this feature flag set are:

  • q or Q or <ESC>: Exit.
  • s: Toggle second display.
  • m: Toggle military (24H) time.
  • c: Center the clock in the terminal.
  • 0..=7: Change to corresponding ANSI color.

References

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

python3_ptock-1.2.0.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

python3_ptock-1.2.0-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file python3_ptock-1.2.0.tar.gz.

File metadata

  • Download URL: python3_ptock-1.2.0.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for python3_ptock-1.2.0.tar.gz
Algorithm Hash digest
SHA256 68e0c3b4e1ec638cdd74099b3cce0de603b7d8f8932968cd75ace0a4472eefb8
MD5 924efc793fa48799dec277c1965a3c2a
BLAKE2b-256 5d06e8eb98aa6ce420f1d0a345ea5d78914aa17cff19b601d5fc60762d74c1ec

See more details on using hashes here.

File details

Details for the file python3_ptock-1.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for python3_ptock-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 000425600f8ab0881bbe7af52fda74f4487c2bd45d12e3b333574cdd0506722d
MD5 72111e287a1ab896dd42d4fefc414ed3
BLAKE2b-256 ad100733b8cd28150e4f61995ac15748c740dc3f019dadb84a881d05f03b8d66

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