Skip to content

Latest commit

 

History

History
99 lines (74 loc) · 3.12 KB

README.md

File metadata and controls

99 lines (74 loc) · 3.12 KB

Tempus PyPI Travis

Hourglass
TEMPUS EST DE ESSENTIA
Time is of the essence

INSTALLATION

$ pip install tempus

Python Versions
3.3 | 3.4 | 3.5 | 3.6

USAGE

Timer

tempus timer <duration>
tempus timer 1m | tempus timer 2m15s | tempus timer 30s | tempus timer 10000s

Tempus Timer

Stopwatch

Coming soon

Metronome

Coming soon

CAVEATS

Font

The progress bar may appear distorted or unsmooth when filling up due to the terminal's font not displaying the unicode characters as intended. Hence, you may need to play around with your font to get the best experience.

$ tempus test
Ensure that the characters below are:
* Equal in height
* Forming a smooth gradient across
* Aesthetically pleasing

|█▉▊▋▌▍▎▏ |
|⣿⣷⣧⣇⡇⡆⡄⡀|

https://github.com/chunkhang/tempus/#font

Recommended Fonts
Menlo | SF Mono

Terminal

The progress bar needs a certain amount of space to ensure proper printing. Therefore, you may get a message if your terminal size is too small. In that case, just adjust your terminal's window before executing the command again.

$ tempus timer 1m
The terminal is too small: 52 x 25
It needs to be at least  : 80 x 10

Minimum Size
80 x 10

RELEASES

1.1.0

  • Shiny new progress bar for timer

1.0.0

  • Initial release

UNLICENSE

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org>

CONTACT

Feel free to report bugs or suggest features
Marcus Mu | chunkhang@gmail.com