# 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:
```bash
pip install pomatillo
```
## Development
Pomatillo uses [Poetry](https://python-poetry.org/) for dependency management and packaging.
If you want to contribute to Pomatillo, here are the steps to get started:
```bash
# 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](https://docs.pytest.org/en/stable/) for testing. To run the
tests, run the following command:
### Using a Poetry managed virtual environment
```bash
poetry run pytest
```
### If you installed it in a custom managed virtual environment
Activate the virtual environment and run the following command:
```bash
python -m pytest
```
## Building docs
Pomatillo uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) for
documentation. To help with various documentation tasks, Pomatillo provides a cli:
- Using a Poetry managed virtual environment
```bash
poetry run pomatillo docs --help
```
- If you installed it in a custom managed virtual environment, activate the virtual
environment first
```bash
python -m pomatillo docs --help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/AdityaGudimella/pomatillo",
"name": "pomatillo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "pomodoro,timer,terminal,tui,cli",
"author": "Aditya Gudimella",
"author_email": "aditya.gudimella@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2f/85/d52943b7fe7a5fb731e583b336a10d656c3311819710700cb5190abdf1ec/pomatillo-0.0.1.tar.gz",
"platform": null,
"description": "# Pomatillo\n\n## Introduction\n\nPomatillo is a simple Pomodoro timer for the command line. It is meant to be used in the\nfollowing modes:\n\n- As a library for other programs\n- As a command line tool (CLI)\n- As a Textual User Interface (TUI)\n\nOther modes may be added upon request.\n\n## Installation\n\nPomatillo supports Python 3.10 and above. To install Pomatillo, run the following command:\n\n```bash\npip install pomatillo\n```\n\n## Development\n\nPomatillo uses [Poetry](https://python-poetry.org/) for dependency management and packaging.\nIf you want to contribute to Pomatillo, here are the steps to get started:\n\n```bash\n# Clone the repo\ngit clone https://github.com/AdityaGudimella/pomatillo\n# Go into the repo\ncd pomatillo\n# Install dependencies using Poetry\npoetry install\n```\n\n## Running tests\n\nPomatillo uses [pytest](https://docs.pytest.org/en/stable/) for testing. To run the\ntests, run the following command:\n\n### Using a Poetry managed virtual environment\n\n```bash\npoetry run pytest\n```\n\n### If you installed it in a custom managed virtual environment\n\nActivate the virtual environment and run the following command:\n\n```bash\npython -m pytest\n```\n\n## Building docs\n\nPomatillo uses [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) for\ndocumentation. To help with various documentation tasks, Pomatillo provides a cli:\n\n- Using a Poetry managed virtual environment\n\n```bash\npoetry run pomatillo docs --help\n```\n\n- If you installed it in a custom managed virtual environment, activate the virtual\n environment first\n\n```bash\npython -m pomatillo docs --help\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A simple pomodoro timer that can be used in a terminal.",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/AdityaGudimella/pomatillo",
"Repository": "https://github.com/AdityaGudimella/pomatillo"
},
"split_keywords": [
"pomodoro",
"timer",
"terminal",
"tui",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "723dc9d92af2b9399a5fb1d46f18ab5f81e8af03691476c4e072afb466d227bb",
"md5": "f7a1cab9f972ff37570dbad372ae2866",
"sha256": "4db8b2d7f53c90e60b7784ddbefce740fc465d6ff4ca876f3c1d4236780e9926"
},
"downloads": -1,
"filename": "pomatillo-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7a1cab9f972ff37570dbad372ae2866",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 2769,
"upload_time": "2023-07-29T22:11:48",
"upload_time_iso_8601": "2023-07-29T22:11:48.822181Z",
"url": "https://files.pythonhosted.org/packages/72/3d/c9d92af2b9399a5fb1d46f18ab5f81e8af03691476c4e072afb466d227bb/pomatillo-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2f85d52943b7fe7a5fb731e583b336a10d656c3311819710700cb5190abdf1ec",
"md5": "09395cd0f63a3ad7aada0c7d72464b38",
"sha256": "13726103b79c2f462149b41a051c95f215a60de13e46f35aec0ec4d9106ab5eb"
},
"downloads": -1,
"filename": "pomatillo-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "09395cd0f63a3ad7aada0c7d72464b38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 3158,
"upload_time": "2023-07-29T22:11:50",
"upload_time_iso_8601": "2023-07-29T22:11:50.451934Z",
"url": "https://files.pythonhosted.org/packages/2f/85/d52943b7fe7a5fb731e583b336a10d656c3311819710700cb5190abdf1ec/pomatillo-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-29 22:11:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AdityaGudimella",
"github_project": "pomatillo",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pomatillo"
}
JSON
