# Pomotime
Pomotime is a simple, customizable terminal-based Pomodoro timer that helps you manage your work and break sessions effectively. It offers flexible settings for session durations, customizable visual styles, fonts and even sound notifications.
## Features
- **Customizable Durations**: Define your own durations for work sessions, short breaks, and long breaks.
- **Customizable Work & Break Sequences**: Set your work and break sequences, for example: "wswl" is "Work, Short Break, Work, Long Break"
- **Flexible Settings**: Choose from different fonts, font styles and colors for the timer display.
- **Sound Alerts**: Configure custom sound notifications to signal the end of each session.
- **Cross-Platform**: Works on macOS, Windows, and Linux.
## Installation
Install via pip:
```bash
pip install pomotime
```
Install via pipx (for Arch and etc.):
```bash
pipx install pomotime
```
## Usage
After installation, you can run `pomotime` from the terminal. Below are some example commands:
- **Start a Pomodoro sequence with the default settings:**
```bash
pomotime
```
- **Customize session durations:**
```bash
pomotime -w 30 -s 10 -l 20
```
- **Customize Pomodoro sequence and work duration:**
```bash
pomotime -w 45 wlwswl
```
- **Disable sound notifications:**
```bash
pomotime --no-sound
```
- **Display the paths to the configuration file and sounds folder:**
```bash
pomotime --config
```
## Configuration
Pomotime uses a TOML configuration file to store customizable settings. By default, the configuration file is located at:
`~/.config/pomotime/pomotime.toml`
There is full documentation inside of pomotime.toml
### Example Configuration File
```toml
[settings]
block_mode = true
solid_mode = false
font = "block"
text_colour_high_percent = "#FFFFFF"
text_colour_mid_percent = "#888888"
text_colour_low_percent = "#666666"
message_color = "yellow"
timer_high_percent = 0.3
timer_low_percent = 0.15
```
### Custom Sounds
Pomotime allows you to use your own sound files for session notifications. By default, the sound file is located at:
`~/.local/share/pomotime/sound.wav`
You can replace this file with your own `.wav` file, or edit the `pomotime.toml` configuration file to point to a different location.
## Acknowledgements
Pomotime is based on the enhanced version of [timer-cli](https://github.com/1Blademaster/timer-cli) by [1Blademaster](https://github.com/1Blademaster).
Special thanks to the following projects for inspiration:
- [peaclock](https://github.com/octobanana/peaclock) by [octobanana](https://github.com/octobanana)
- [gone](https://github.com/guillaumebreton/gone) by [guillaumebreton](https://github.com/guillaumebreton)
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
## License
Pomotime is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more details.
---
<p align="center">
Made with ❤️ by <a href="https://github.com/zabojeb">zabojeb</a>
</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/zabojeb/pomotime",
"name": "pomotime",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": null,
"author": "zabojeb",
"author_email": "zabojeb@bk.ru",
"download_url": "https://files.pythonhosted.org/packages/b6/10/14f907416361e91f94ab0302ca65ae539732bb9998fe396689d557973691/pomotime-1.0.2.tar.gz",
"platform": null,
"description": "# Pomotime\r\n\r\nPomotime is a simple, customizable terminal-based Pomodoro timer that helps you manage your work and break sessions effectively. It offers flexible settings for session durations, customizable visual styles, fonts and even sound notifications.\r\n\r\n## Features\r\n\r\n- **Customizable Durations**: Define your own durations for work sessions, short breaks, and long breaks.\r\n- **Customizable Work & Break Sequences**: Set your work and break sequences, for example: \"wswl\" is \"Work, Short Break, Work, Long Break\"\r\n- **Flexible Settings**: Choose from different fonts, font styles and colors for the timer display.\r\n- **Sound Alerts**: Configure custom sound notifications to signal the end of each session.\r\n- **Cross-Platform**: Works on macOS, Windows, and Linux.\r\n\r\n## Installation\r\n\r\nInstall via pip:\r\n\r\n```bash\r\npip install pomotime\r\n```\r\n\r\nInstall via pipx (for Arch and etc.):\r\n\r\n```bash\r\npipx install pomotime\r\n```\r\n\r\n## Usage\r\n\r\nAfter installation, you can run `pomotime` from the terminal. Below are some example commands:\r\n\r\n- **Start a Pomodoro sequence with the default settings:**\r\n\r\n ```bash\r\n pomotime\r\n ```\r\n\r\n- **Customize session durations:**\r\n\r\n ```bash\r\n pomotime -w 30 -s 10 -l 20\r\n ```\r\n\r\n- **Customize Pomodoro sequence and work duration:**\r\n\r\n ```bash\r\n pomotime -w 45 wlwswl\r\n ```\r\n\r\n- **Disable sound notifications:**\r\n\r\n ```bash\r\n pomotime --no-sound\r\n ```\r\n\r\n- **Display the paths to the configuration file and sounds folder:**\r\n\r\n ```bash\r\n pomotime --config\r\n ```\r\n\r\n## Configuration\r\n\r\nPomotime uses a TOML configuration file to store customizable settings. By default, the configuration file is located at:\r\n\r\n`~/.config/pomotime/pomotime.toml`\r\n\r\nThere is full documentation inside of pomotime.toml\r\n\r\n### Example Configuration File\r\n\r\n```toml\r\n[settings]\r\nblock_mode = true\r\nsolid_mode = false\r\nfont = \"block\"\r\ntext_colour_high_percent = \"#FFFFFF\"\r\ntext_colour_mid_percent = \"#888888\"\r\ntext_colour_low_percent = \"#666666\"\r\nmessage_color = \"yellow\"\r\ntimer_high_percent = 0.3\r\ntimer_low_percent = 0.15\r\n```\r\n\r\n### Custom Sounds\r\n\r\nPomotime allows you to use your own sound files for session notifications. By default, the sound file is located at:\r\n\r\n`~/.local/share/pomotime/sound.wav`\r\n\r\nYou can replace this file with your own `.wav` file, or edit the `pomotime.toml` configuration file to point to a different location.\r\n\r\n## Acknowledgements\r\n\r\nPomotime is based on the enhanced version of [timer-cli](https://github.com/1Blademaster/timer-cli) by [1Blademaster](https://github.com/1Blademaster).\r\n\r\nSpecial thanks to the following projects for inspiration:\r\n\r\n- [peaclock](https://github.com/octobanana/peaclock) by [octobanana](https://github.com/octobanana)\r\n- [gone](https://github.com/guillaumebreton/gone) by [guillaumebreton](https://github.com/guillaumebreton)\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please open an issue or submit a pull request on GitHub.\r\n\r\n## License\r\n\r\nPomotime is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more details.\r\n\r\n---\r\n\r\n<p align=\"center\">\r\n Made with \u2764\ufe0f by <a href=\"https://github.com/zabojeb\">zabojeb</a>\r\n</p>\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Stylish customizable CLI Pomodoro timer",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/zabojeb/pomotime"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e794d930f5ebf8ae949f30e918b29450b3aa8aeb18de6e09f0333589e69255d6",
"md5": "e00c0d1a4844845979933785383e696d",
"sha256": "a8f2b71ac0f72698d3a515f994d80edff5d65df9e7b8efcd7ae69d05ad80a126"
},
"downloads": -1,
"filename": "pomotime-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e00c0d1a4844845979933785383e696d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 54521,
"upload_time": "2024-08-18T12:53:26",
"upload_time_iso_8601": "2024-08-18T12:53:26.347669Z",
"url": "https://files.pythonhosted.org/packages/e7/94/d930f5ebf8ae949f30e918b29450b3aa8aeb18de6e09f0333589e69255d6/pomotime-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b61014f907416361e91f94ab0302ca65ae539732bb9998fe396689d557973691",
"md5": "354b286dc93faddfe4cc1f5241a87936",
"sha256": "013c8c9389e456d434616ca17d384930fd2cbaa8dd670b748de47dad8e19a80a"
},
"downloads": -1,
"filename": "pomotime-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "354b286dc93faddfe4cc1f5241a87936",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 32904,
"upload_time": "2024-08-18T12:53:27",
"upload_time_iso_8601": "2024-08-18T12:53:27.897525Z",
"url": "https://files.pythonhosted.org/packages/b6/10/14f907416361e91f94ab0302ca65ae539732bb9998fe396689d557973691/pomotime-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 12:53:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zabojeb",
"github_project": "pomotime",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pomotime"
}
JSON
