callumr/oura-daily-scores
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Display your Oura Daily Scores in your terminal.
7 commits 1 branch 0 tags 66 KiB
  • Python 100%
Find a file
Exact
callumr00 22323b5c54 🔨 Corrected instructed alias command
2023-12-24 18:40:52 +00:00
.gitignore ➕ Initial commit. 2023-12-18 10:14:46 +00:00
config.sample.json ➕ Initial commit. 2023-12-18 10:14:46 +00:00
oura.py 🔨 Fixed calling oura from a different directory. 2023-12-24 18:38:25 +00:00
README.md 🔨 Fixed calling oura from a different directory. 2023-12-24 18:38:25 +00:00
screenshot.png ➕ Added screenshot 2023-12-20 18:41:31 +00:00

README.md

Oura Daily Scores

Display your Oura Daily Scores in your terminal.

Screenshot

How It Works

Python is used to connect to the Oura API and retrieve the day's Readiness, Sleep, and Activity scores. These scores are then plotted as donut charts and the figure is saved. jp2a is passed the image and generates an ASCII art replica in the terminal. The image is then deleted.

Dependencies

Instructions

Clone the repo

git clone https://github.com/callumr00/oura-daily-scores.git

Insert your API key

First, copy the sample config file.

cp config.sample.json config.json

Then, open config.json and replace "YOUR_API_KEY" with your actual API key.

Create the alias command

Add the following to your ~/.bashrc file.

# Print Oura Daily Scores in terminal.
export OURA_DIR=path/to/oura-daily-scores
alias oura="(
    python ${OURA_DIR}oura.py &&
    jp2a ${OURA_DIR}daily_scores.png &&
    rm ${OURA_DIR}daily_scores.png
)"

Ensure to change the value of OURA_DIR accordingly.

Execute

After setting the alias, execute oura in the terminal.