A simple pomodoro timer that can be used in a terminal.
Project description
Pomatillo
Introduction
Pomatillo is a simple Pomodoro timer for the command line. It is meant to be used in the following modes:
- As a library for other programs
- As a command line tool (CLI)
- As a Textual User Interface (TUI)
Other modes may be added upon request.
Installation
Pomatillo supports Python 3.10 and above. To install Pomatillo, run the following command:
pip install pomatillo
Development
Pomatillo uses Poetry for dependency management and packaging. If you want to contribute to Pomatillo, here are the steps to get started:
# Clone the repo
git clone https://github.com/AdityaGudimella/pomatillo
# Go into the repo
cd pomatillo
# Install dependencies using Poetry
poetry install
Running tests
Pomatillo uses pytest for testing. To run the tests, run the following command:
Using a Poetry managed virtual environment
poetry run pytest
If you installed it in a custom managed virtual environment
Activate the virtual environment and run the following command:
python -m pytest
Building docs
Pomatillo uses MkDocs Material for documentation. To help with various documentation tasks, Pomatillo provides a cli:
- Using a Poetry managed virtual environment
poetry run pomatillo docs --help
- If you installed it in a custom managed virtual environment, activate the virtual environment first
python -m pomatillo docs --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pomatillo-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4db8b2d7f53c90e60b7784ddbefce740fc465d6ff4ca876f3c1d4236780e9926 |
|
MD5 | f7a1cab9f972ff37570dbad372ae2866 |
|
BLAKE2b-256 | 723dc9d92af2b9399a5fb1d46f18ab5f81e8af03691476c4e072afb466d227bb |