-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
47 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,56 @@ | ||
[![pypresence](https://img.shields.io/badge/using-pypresence-00bb88.svg?style=for-the-badge&logo=discord&logoWidth=20)](https://github.com/qwertyquerty/pypresence) | ||
|
||
# WIP | ||
|
||
Pomodoro timer GUI with Discord Rich Presence integration and stats tracking | ||
# Pomodoro Discord | ||
|
||
## Acknowledgements | ||
Broadcast your study sessions. | ||
|
||
Some themes adapted from: https://github.com/avalon60/ctk_theme_builder/tree/develop/user_themes | ||
![Screenshot](screenshots/screenshot.png) | ||
|
||
## Running from Source | ||
|
||
1. Clone the repository | ||
``` | ||
git clone https://github.com/jake158/pomodoro-discord.git | ||
``` | ||
2. Go into the project directory and install the requirements | ||
``` | ||
cd pomodoro-discord | ||
pip install -r requirements.txt | ||
``` | ||
3. Run simple tests (Ignore ResourceWarnings) | ||
``` | ||
python3 -m unittest discover tests` | ||
``` | ||
4. Run | ||
``` | ||
python3 main.py | ||
``` | ||
## Features | ||
## Testing | ||
`pip install -r requirements.txt` | ||
Adjusting all durations | ||
`python3 -m unittest discover tests` | ||
Option to automatically cycle to a break after a session ends | ||
Ignore ResourceWarnings, if any show up. | ||
Connecting and disconnecting Rich Presence by pressing "Connected to Discord" on the main tab | ||
Tracks: | ||
- Total time studied | ||
- Time studied on each particular day | ||
- Total pomodoro sessions | ||
- Pomodoro sessions on each particular day | ||
Matplotlib plots: | ||
![Graph screenshot](screenshots/screenshot2.png) | ||
## Acknowledgements | ||
Some themes adapted from: https://github.com/avalon60/ctk_theme_builder/tree/develop/user_themes | ||
## Running | ||
`python3 main.py` | ||
Current themes apart from the default one are pretty hideous but I will adjust them when I get to them. |