https://github.com/vaaaaanquish/pyoklock
pyoklock : python cli digital clock.
https://github.com/vaaaaanquish/pyoklock
Last synced: 2 days ago
JSON representation
pyoklock : python cli digital clock.
- Host: GitHub
- URL: https://github.com/vaaaaanquish/pyoklock
- Owner: vaaaaanquish
- License: mit
- Created: 2019-06-30T13:20:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-28T02:59:47.000Z (over 4 years ago)
- Last Synced: 2024-08-10T03:15:49.378Z (9 months ago)
- Language: Python
- Homepage:
- Size: 568 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# pyoklock
python cli clock. Display digital clock on terminal.
# Usage
## install
```
# require ptk 3.x : https://github.com/prompt-toolkit/python-prompt-toolkit
pip install pyoklock
```
## args: second
If you want display `second`, add `-s` or `--second` to the argument.
```
pyoklock -s
```
## args: frame
If you want display clock frame, add `-f` or `--frame` to the argument.
```
pyoklock -f
```
## args: google_calender
If you want display Google Calender's moost recent event, add `-g` or `--google_calender` to the argument.
To use this args, you must get `Google API OAuth Client credentails`.
If you got `credentails`, put it at `~/.pyoklock/` with the name `credentails.json`
OAuth Client credentails from: https://console.cloud.google.com/
```
mkdir ~/.pyoklock
mv [[your credentail path]] ~/.pyoklock/credentials.json
```
Then run pyoklock.
```
pyoklock -g
```
If you want to delete the cache, remove `~/.pyoklock/token.pickle`.
### print event num
If you want to limit the number of events, using `--events` args.
for example:
```
pyoklock -g --events 5
```
### event today only
If you want to put `event of today only`, using `-t` or `--today` args.
for example:
```
pyoklock -g -t --events 10
```
### change the color
If you want to change the color according to the time, using `-c` or `--color` args. It's function for alert.
- google calender events
- 5 minutes ago: Red
- within 15 minutes: Green
## args: model
If you want to change clock size, add `--model` to the argument.
Selectable numbers are {0,1,2}. default is 1.
for example:
```
pyoklock -f -s --model 0
```
## change digit character
If you want to change clock's character, set `$PYOKLOCK_BACK_CHAR` or `$PYOKLOCK_DIGIT_CHAR` to OS environment.
for example:
```
export PYOKLOCK_BACK_CHAR="@"
export PYOKLOCK_DIGIT_CHAR=" "
pyoklock -s
```
# Special thanks to
- [python prompt-toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit) : pyoklock made by this cli tools.
# License
This software is released under the MIT License, see LICENSE.txt.
# Why PyOkLock?
python clock. -> pyoklock
This is the same way as the artist " [ONE OK ROCK](http://www.oneokrock.com) " I respect.