Skip to main content

Minimalist terminal digital clock

Project description

darshell-clock

Python application Build Status GitHub last commit Github last version License: MIT

:warning: Please use pip3 or python3 instead of pip and python

darshellclock is a MINIMALIST console application to display time and date with nice ASCII digits in your terminal. Uses curses

Here is a demo but mostly you would use this in a small persistant terminal. (More on "why this project?" in the side notes at the end)

darshellclock demo

Features

Suitable for quite small terminal sizes. Useful for having a clock sitting around if you use a tiling window manager or tmux for example.

  • Nice 'blocky' ASCII digits :purple_heart:
  • Localised date format :airplane:
  • 2 sizes of digits, smaller digits for smaller term
  • Autoresizing and centering
  • Color selection of the time or the date
  • Possibility to hide the date and/or the seconds
  • Autoclosing (if wanted, see arguments in 'Usage and keys')
  • All the parameters are saved upon exit :+1:

Usage and keys

The usual arguments are here + a 'stop' argument for the autoclosing functionnality

-h --help        Show help
-v --version     Show version number
-i --info        Show info [ASCII ♥]
-s --stop STOP   Quit the application after <STOP> seconds

While in the app, use these keys to change the configuration :

Key Purpose
h Show or hide help
q Quit
z Change time color
x Change date color
d Show or hide date
s Show or hide secs

Installing and starting

Use Python 3.x

:warning: Please use pip3 or python3 instead of pip and python

Install using pip3:

 pip3 install darshellclock 	# installing
 darshellclock			# lauching

Or if you want to do it manually you can clone or downlad and extract the project:

$ git clone https://github.com/darokin/darshell-clock.git
$ cd darshell-clock 
$ python3 darshellclock           # to launch/test ; or you can install it :
$ python3 setup.py install --user # to install
$ darshellclock                   # to launch installed version

Side notes

:information_desk_person: This program was mainly made to try out a whole life cycle of a simple python app and to grasp new skills around github/CI/python package distribution/etc. The discussion section is open if needed.

If you encounter any problem or have any suggestions, please open an issue or send a pull request.

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

darshellclock-1.1.2.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

darshellclock-1.1.2-py3-none-any.whl (12.3 kB view hashes)

Uploaded Python 3

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