Skip to content

Commit

Permalink
ready for 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
moiSentineL committed Jul 3, 2024
1 parent 11c0494 commit 809cb28
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ pip install -e .

## Usage

### Known Issues

- Skip doesn't work while on break (you can just make another session).
- Might not work if you have attention span of a goldfish.

### Getting Started

Start a flow with tag "work" and "write some code" as session name:
Expand All @@ -64,7 +69,15 @@ flomo start -t work -n "write some code"

```bash
flomo --help
start, s starts a flow session
Usage: flomo [OPTIONS] COMMAND [ARGS]...

A Flowmodoro CLI for productivity enthusiasts.

Options:
--help Show this message and exit.

Commands:
start (s) Start a Flowmodoro session.
```

<!--
Expand All @@ -75,10 +88,10 @@ flomo --help

## Roadmap

- [x] Add sound on timer/stopwatch start
- [x] Notification (only Linux for now)
- [ ] Tracking data / time studied
- [ ] Configure colors
- [x] Add sound on timer/stopwatch start
- [x] Notification (only Linux for now)
- [ ] Tracking data / time studied
- [ ] Configure colors

Check our [Kanban Board](https://github.com/users/moiSentineL/projects/2)

Expand Down
4 changes: 3 additions & 1 deletion flomo/ui.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ def play_sound():
path = os.path.join(dir_path + file)

if not platform.system().lower() in ["windows", "darwin"]:
os.system("notify-send 'Flomo' 'Time to start flowing!' -u normal && paplay " + file)
os.system(
"notify-send 'Flomo' 'Time to start flowing!' -u normal && paplay " + file
)
else:
playsound(path)

Expand Down
5 changes: 2 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
from setuptools import find_packages, setup

AUTHOR = "Dark Circles"
VERSION = "0.0.3"
VERSION = "0.1.0"
SHORT_DESCRIPTION = "A Flowmodoro CLI for producitivity enthusiasts."
AUTHOR_EMAIL = "<[email protected]>"
URL = "https://github.com/moiSentineL/flomo"
INSTALL_REQUIRES = ["click", "blessed", "rich",
"playsound==1.2.2", "click-aliases"]
INSTALL_REQUIRES = ["click", "blessed", "rich", "playsound==1.2.2", "click-aliases"]
PROJECT_URLS = {
"Documentation": "https://github.com/moiSentineL/flomo#flomo",
"Issue tracker": "https://github.com/moiSentineL/flomo/issues",
Expand Down

0 comments on commit 809cb28

Please sign in to comment.