---
A pomodoro timer that grows procedurally generated trees and flowers while you're studying.
## Running Florodoro
First, install the app by running
```
pip install florodoro
```
To launch the application, simply run the `florodoro` command from a terminal of your choice.
If you'd like to use the latest (unstable) version, install from TestPyPI using
```
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple florodoro
```
## Controls
### Top bar
- **Presets** – contains common pomodoro timings for study/break/cycle
- **Options**
- **Notify** – notification options (sound/pop-ups)
- **Plants** – plant settings (which ones to grow)
- **Overstudy** – enables breaks and studies longer than set
- **Statistics** – shows statistics + an interactive plant gallery
- **About** – a small TLDR about the project
### Bottom bar
- **Study for ...** – how long to study for
- **Break for ...** – how long to break after study
- **Cycles: ...** – how many times to repeat study-break (0 means infinite)
- **Icon: Book** – start the study session
- **Icon: Coffee** – start a break
- **Icon: Pause/continue** – pause/continue an ongoing study/break
- **Icon: Reset** – reset everything
## Local development
### Setup
1. create virtual environment: `python3 -m venv venv`
2. activate it `. venv/bin/activate` (assuming you use Bash)
3. install the package locally: `python3 -m pip install -e .`
- the `-e` flag ensures local changes are used when running the package
4. develop
5. run `florodoro` (make sure that `venv` is active)
_Note: this might not work when the path to the cloned reposity contains whitespace. I didn't look into the reason why (likely a bug in `venv`), just something to try if something fails._
### Publishing
All tagged commits in the `x.y.z` format are automatically published on PyPi using GitGub Actions.
If the commit is on the `testing` branch, the test PyPi instance is used.
The project follows [Semver](https://semver.org/) for version numbers and is currently under MAJOR version `0` (under rapid prototyping).
For as long as this is the case, the master branch will only contain MINOR versions, while the testing branch will contain PATCH versions.
Raw data
{
"_id": null,
"home_page": "https://github.com/xiaoxiae/Florodoro",
"name": "florodoro",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.1",
"maintainer_email": "",
"keywords": "education pyqt5 plants pomodoro",
"author": "Tom\u00e1\u0161 Sl\u00e1ma",
"author_email": "tomas@slama.dev",
"download_url": "https://files.pythonhosted.org/packages/99/ef/9c796375b4c303d8e47f8013efacaee30e0d31d94f0364108d9c52735e6a/florodoro-0.8.tar.gz",
"platform": null,
"description": "\n\n---\n\nA pomodoro timer that grows procedurally generated trees and flowers while you're studying.\n\n\n\n## Running Florodoro\nFirst, install the app by running\n```\npip install florodoro\n```\n\nTo launch the application, simply run the `florodoro` command from a terminal of your choice.\n\nIf you'd like to use the latest (unstable) version, install from TestPyPI using\n```\npip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple florodoro\n```\n\n## Controls\n\n### Top bar\n- **Presets** \u2013 contains common pomodoro timings for study/break/cycle\n- **Options**\n\t- **Notify** \u2013 notification options (sound/pop-ups)\n\t- **Plants** \u2013 plant settings (which ones to grow)\n\t- **Overstudy** \u2013 enables breaks and studies longer than set\n- **Statistics** \u2013 shows statistics + an interactive plant gallery\n- **About** \u2013 a small TLDR about the project\n\n### Bottom bar\n- **Study for ...** \u2013 how long to study for\n- **Break for ...** \u2013 how long to break after study\n- **Cycles: ...** \u2013 how many times to repeat study-break (0 means infinite)\n- **Icon: Book** \u2013 start the study session\n- **Icon: Coffee** \u2013 start a break\n- **Icon: Pause/continue** \u2013 pause/continue an ongoing study/break\n- **Icon: Reset** \u2013 reset everything\n\n## Local development\n\n### Setup\n1. create virtual environment: `python3 -m venv venv`\n2. activate it `. venv/bin/activate` (assuming you use Bash)\n3. install the package locally: `python3 -m pip install -e .`\n\t- the `-e` flag ensures local changes are used when running the package\n4. develop\n5. run `florodoro` (make sure that `venv` is active)\n\n_Note: this might not work when the path to the cloned reposity contains whitespace. I didn't look into the reason why (likely a bug in `venv`), just something to try if something fails._\n\n### Publishing\nAll tagged commits in the `x.y.z` format are automatically published on PyPi using GitGub Actions.\nIf the commit is on the `testing` branch, the test PyPi instance is used.\n\nThe project follows [Semver](https://semver.org/) for version numbers and is currently under MAJOR version `0` (under rapid prototyping).\nFor as long as this is the case, the master branch will only contain MINOR versions, while the testing branch will contain PATCH versions.\n",
"bugtrack_url": null,
"license": "",
"summary": "A pomodoro timer that grows procedurally generated trees and flowers while you're studying.",
"version": "0.8",
"split_keywords": [
"education",
"pyqt5",
"plants",
"pomodoro"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ddc7405b4aea55a90259215ffd3ea3d89020835b859c180b2e6ebe0355fee79e",
"md5": "596338efcb1476c007029ef7454880e6",
"sha256": "623e27679046887f581dab92c8244ef506e725b13b96cdb343888ab6d29b8b36"
},
"downloads": -1,
"filename": "florodoro-0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "596338efcb1476c007029ef7454880e6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.1",
"size": 516377,
"upload_time": "2023-01-12T10:23:46",
"upload_time_iso_8601": "2023-01-12T10:23:46.794783Z",
"url": "https://files.pythonhosted.org/packages/dd/c7/405b4aea55a90259215ffd3ea3d89020835b859c180b2e6ebe0355fee79e/florodoro-0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "99ef9c796375b4c303d8e47f8013efacaee30e0d31d94f0364108d9c52735e6a",
"md5": "35a9686868a891b84657365e2120ef4d",
"sha256": "1d97fbbe5e88a2ef250f60096c094df305a9a69109b205f682e7318bb87ed024"
},
"downloads": -1,
"filename": "florodoro-0.8.tar.gz",
"has_sig": false,
"md5_digest": "35a9686868a891b84657365e2120ef4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.1",
"size": 503297,
"upload_time": "2023-01-12T10:23:48",
"upload_time_iso_8601": "2023-01-12T10:23:48.427743Z",
"url": "https://files.pythonhosted.org/packages/99/ef/9c796375b4c303d8e47f8013efacaee30e0d31d94f0364108d9c52735e6a/florodoro-0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-12 10:23:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "xiaoxiae",
"github_project": "Florodoro",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "florodoro"
}
JSON
