Skip to main content

Simple pomodoro cli app that fill as bookshelf with a random book every session

Project description

STACKODORO-CLI

A cozy Pomodoro terminal cli app. For every work session you complete, a random book is added to your bookshelf.

Showcase

Features

  • Built entirely for the terminal using urwid.
  • Integrated music player: Pick the local directory of your playlist, play/pause music, skip tracks, and adjust the volume directly within the TUI.
  • Customizable Timers:: Set your own durations for work, break, and long break sessions.
  • Audio Cues: Automatically pauses your music and plays a transition sound when a session finishes. Music resumes when you start your next work session.
  • Persistent State: Your bookshelf progress, completed shelves, and last used playlist directory are automatically saved using OS-specific standard data directories (handled by platformdirs).

Windows Compatibility

While stackodoro-cli works well on Linux and macOS, the underlying TUI library (urwid) has experimental and often glitchy support for native Windows command prompts (CMD/PowerShell).

For Windows users, we highly recommend installing Windows Subsystem for Linux (WSL) and running the app from there for the best experience.

Dependencies

This project requires pipx to install. If you don't have it yet:

# Linux 
python3 -m pip install --user pipx
python3 -m pipx ensurepath

For more details, see the official pipx installation guide.

Building from Source

git clone https://github.com/PauloFRC/stackodoro-cli
cd stackodoro-cli
pipx install -e --force .

Running

Once installed, you can launch the app from anywhere in your terminal:

stackodoro

Controls

Key Action
Space Start / Pause Timer / Confirm Session Transition
+ / = Increase Music Volume
- / _ Decrease Music Volume
Esc Close open dialog menus
q / Q Save and Quit Application

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stackodoro-0.1.0.tar.gz (20.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stackodoro-0.1.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

Details for the file stackodoro-0.1.0.tar.gz.

File metadata

  • Download URL: stackodoro-0.1.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for stackodoro-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b55c85e0a79ab8ff65ba4e76bac5b03679ba008080a3a5db47033c4e6d438820
MD5 458aa28a99b7c0667966e4595ae2fa4f
BLAKE2b-256 e9f09c8fd4f83d0a54a0275b98035a67adff128c1e9b460fc89872c0b57f9b0e

See more details on using hashes here.

File details

Details for the file stackodoro-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: stackodoro-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for stackodoro-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c39ee6c649246b900b2d0786fe6cfea89f1897a0a429cac874fa245f46a8311
MD5 19df65077f8611033cfdd9fad99dd3ab
BLAKE2b-256 8c947b74f77bdd31152fb9ce612c40bd77dc53075295f97ecccc061116cd2bb9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page