matchamomo 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- matchamomo-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md +23 -0
- matchamomo-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md +12 -0
- matchamomo-0.1.0/.github/PULL_REQUEST_TEMPLATE.md +8 -0
- matchamomo-0.1.0/.github/dependabot.yml +11 -0
- matchamomo-0.1.0/.github/workflows/ci.yml +64 -0
- matchamomo-0.1.0/.github/workflows/release.yml +77 -0
- matchamomo-0.1.0/.gitignore +220 -0
- matchamomo-0.1.0/CHANGELOG.md +18 -0
- matchamomo-0.1.0/LICENSE +21 -0
- matchamomo-0.1.0/PKG-INFO +93 -0
- matchamomo-0.1.0/README.md +66 -0
- matchamomo-0.1.0/pyproject.toml +69 -0
- matchamomo-0.1.0/src/matchamomo/__init__.py +6 -0
- matchamomo-0.1.0/src/matchamomo/__main__.py +86 -0
- matchamomo-0.1.0/src/matchamomo/app.py +443 -0
- matchamomo-0.1.0/src/matchamomo/cats.py +303 -0
- matchamomo-0.1.0/src/matchamomo/stage.py +253 -0
- matchamomo-0.1.0/src/matchamomo/timer.py +192 -0
- matchamomo-0.1.0/tests/test_app.py +134 -0
- matchamomo-0.1.0/tests/test_cats.py +54 -0
- matchamomo-0.1.0/tests/test_timer.py +110 -0
- matchamomo-0.1.0/uv.lock +465 -0
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Report a bug in MatchaMomo
|
|
4
|
+
title: "[Bug]: "
|
|
5
|
+
labels: bug
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Description
|
|
9
|
+
A clear description of what the bug is.
|
|
10
|
+
|
|
11
|
+
## Steps to Reproduce
|
|
12
|
+
1. Run `uv run matchamomo ...`
|
|
13
|
+
2. Press ...
|
|
14
|
+
3. Observe ...
|
|
15
|
+
|
|
16
|
+
## Expected Behavior
|
|
17
|
+
What you expected to happen.
|
|
18
|
+
|
|
19
|
+
## Environment
|
|
20
|
+
- OS: (e.g., macOS 15, Ubuntu 24.04)
|
|
21
|
+
- Terminal: (e.g., iTerm2, Kitty, Alacritty, Windows Terminal)
|
|
22
|
+
- Python version:
|
|
23
|
+
- MatchaMomo version:
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Feature request
|
|
3
|
+
about: Suggest an idea for MatchaMomo
|
|
4
|
+
title: "[Feature]: "
|
|
5
|
+
labels: enhancement
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
A clear description of the feature or cat animation you'd like to see.
|
|
10
|
+
|
|
11
|
+
## Motivation
|
|
12
|
+
Why would this be useful or fun?
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
11
|
+
cancel-in-progress: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
lint-and-typecheck:
|
|
15
|
+
name: Lint & Typecheck
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
steps:
|
|
18
|
+
- uses: actions/checkout@v4
|
|
19
|
+
|
|
20
|
+
- name: Set up uv
|
|
21
|
+
uses: astral-sh/setup-uv@v5
|
|
22
|
+
with:
|
|
23
|
+
enable-cache: true
|
|
24
|
+
|
|
25
|
+
- name: Install dependencies
|
|
26
|
+
run: uv sync --locked
|
|
27
|
+
|
|
28
|
+
- name: Ruff format check
|
|
29
|
+
run: uv run ruff format --check .
|
|
30
|
+
|
|
31
|
+
- name: Ruff lint
|
|
32
|
+
run: uv run ruff check .
|
|
33
|
+
|
|
34
|
+
- name: Mypy typecheck
|
|
35
|
+
run: uv run mypy src tests
|
|
36
|
+
|
|
37
|
+
test:
|
|
38
|
+
name: Test (${{ matrix.os }}, Python ${{ matrix.python-version }})
|
|
39
|
+
runs-on: ${{ matrix.os }}
|
|
40
|
+
strategy:
|
|
41
|
+
fail-fast: false
|
|
42
|
+
matrix:
|
|
43
|
+
os: [ubuntu-latest, macos-latest]
|
|
44
|
+
python-version: ["3.12", "3.13"]
|
|
45
|
+
steps:
|
|
46
|
+
- uses: actions/checkout@v4
|
|
47
|
+
|
|
48
|
+
- name: Set up uv
|
|
49
|
+
uses: astral-sh/setup-uv@v5
|
|
50
|
+
with:
|
|
51
|
+
python-version: ${{ matrix.python-version }}
|
|
52
|
+
enable-cache: true
|
|
53
|
+
|
|
54
|
+
- name: Install dependencies
|
|
55
|
+
run: uv sync --locked
|
|
56
|
+
|
|
57
|
+
- name: Run tests
|
|
58
|
+
run: uv run pytest -v
|
|
59
|
+
|
|
60
|
+
- name: Build package
|
|
61
|
+
run: uv build
|
|
62
|
+
|
|
63
|
+
- name: CLI smoke test
|
|
64
|
+
run: uv run matchamomo --help
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags:
|
|
6
|
+
- "v*.*.*"
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
build:
|
|
10
|
+
name: Verify & Build Distributions
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
steps:
|
|
13
|
+
- uses: actions/checkout@v4
|
|
14
|
+
|
|
15
|
+
- name: Set up uv
|
|
16
|
+
uses: astral-sh/setup-uv@v5
|
|
17
|
+
with:
|
|
18
|
+
enable-cache: true
|
|
19
|
+
|
|
20
|
+
- name: Install dependencies
|
|
21
|
+
run: uv sync --locked
|
|
22
|
+
|
|
23
|
+
- name: Lint & typecheck
|
|
24
|
+
run: |
|
|
25
|
+
uv run ruff format --check .
|
|
26
|
+
uv run ruff check .
|
|
27
|
+
uv run mypy src tests
|
|
28
|
+
|
|
29
|
+
- name: Run tests
|
|
30
|
+
run: uv run pytest -v
|
|
31
|
+
|
|
32
|
+
- name: Build distributions
|
|
33
|
+
run: uv build
|
|
34
|
+
|
|
35
|
+
- name: Upload distribution artifacts
|
|
36
|
+
uses: actions/upload-artifact@v4
|
|
37
|
+
with:
|
|
38
|
+
name: dist
|
|
39
|
+
path: dist/*
|
|
40
|
+
|
|
41
|
+
github-release:
|
|
42
|
+
name: Create GitHub Release
|
|
43
|
+
needs: build
|
|
44
|
+
runs-on: ubuntu-latest
|
|
45
|
+
permissions:
|
|
46
|
+
contents: write
|
|
47
|
+
steps:
|
|
48
|
+
- name: Download distribution artifacts
|
|
49
|
+
uses: actions/download-artifact@v4
|
|
50
|
+
with:
|
|
51
|
+
name: dist
|
|
52
|
+
path: dist
|
|
53
|
+
|
|
54
|
+
- name: Create GitHub Release
|
|
55
|
+
uses: softprops/action-gh-release@v2
|
|
56
|
+
with:
|
|
57
|
+
generate_release_notes: true
|
|
58
|
+
files: dist/*
|
|
59
|
+
|
|
60
|
+
publish-pypi:
|
|
61
|
+
name: Publish to PyPI
|
|
62
|
+
needs: build
|
|
63
|
+
runs-on: ubuntu-latest
|
|
64
|
+
environment:
|
|
65
|
+
name: pypi
|
|
66
|
+
url: https://pypi.org/p/matchamomo
|
|
67
|
+
permissions:
|
|
68
|
+
id-token: write
|
|
69
|
+
steps:
|
|
70
|
+
- name: Download distribution artifacts
|
|
71
|
+
uses: actions/download-artifact@v4
|
|
72
|
+
with:
|
|
73
|
+
name: dist
|
|
74
|
+
path: dist
|
|
75
|
+
|
|
76
|
+
- name: Publish package to PyPI
|
|
77
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[codz]
|
|
4
|
+
*$py.class
|
|
5
|
+
|
|
6
|
+
# C extensions
|
|
7
|
+
*.so
|
|
8
|
+
|
|
9
|
+
# Distribution / packaging
|
|
10
|
+
.Python
|
|
11
|
+
build/
|
|
12
|
+
develop-eggs/
|
|
13
|
+
dist/
|
|
14
|
+
downloads/
|
|
15
|
+
eggs/
|
|
16
|
+
.eggs/
|
|
17
|
+
lib/
|
|
18
|
+
lib64/
|
|
19
|
+
parts/
|
|
20
|
+
sdist/
|
|
21
|
+
var/
|
|
22
|
+
wheels/
|
|
23
|
+
share/python-wheels/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.installed.cfg
|
|
26
|
+
*.egg
|
|
27
|
+
MANIFEST
|
|
28
|
+
|
|
29
|
+
# PyInstaller
|
|
30
|
+
# Usually these files are written by a python script from a template
|
|
31
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
|
32
|
+
*.manifest
|
|
33
|
+
*.spec
|
|
34
|
+
|
|
35
|
+
# Installer logs
|
|
36
|
+
pip-log.txt
|
|
37
|
+
pip-delete-this-directory.txt
|
|
38
|
+
|
|
39
|
+
# Unit test / coverage reports
|
|
40
|
+
htmlcov/
|
|
41
|
+
.tox/
|
|
42
|
+
.nox/
|
|
43
|
+
.coverage
|
|
44
|
+
.coverage.*
|
|
45
|
+
.cache
|
|
46
|
+
nosetests.xml
|
|
47
|
+
coverage.xml
|
|
48
|
+
*.cover
|
|
49
|
+
*.py.cover
|
|
50
|
+
*.lcov
|
|
51
|
+
.hypothesis/
|
|
52
|
+
.pytest_cache/
|
|
53
|
+
cover/
|
|
54
|
+
|
|
55
|
+
# Translations
|
|
56
|
+
*.mo
|
|
57
|
+
*.pot
|
|
58
|
+
|
|
59
|
+
# Django stuff:
|
|
60
|
+
*.log
|
|
61
|
+
local_settings.py
|
|
62
|
+
db.sqlite3
|
|
63
|
+
db.sqlite3-journal
|
|
64
|
+
|
|
65
|
+
# Flask stuff:
|
|
66
|
+
instance/
|
|
67
|
+
.webassets-cache
|
|
68
|
+
|
|
69
|
+
# Scrapy stuff:
|
|
70
|
+
.scrapy
|
|
71
|
+
|
|
72
|
+
# Sphinx documentation
|
|
73
|
+
docs/_build/
|
|
74
|
+
|
|
75
|
+
# PyBuilder
|
|
76
|
+
.pybuilder/
|
|
77
|
+
target/
|
|
78
|
+
|
|
79
|
+
# Jupyter Notebook
|
|
80
|
+
.ipynb_checkpoints
|
|
81
|
+
|
|
82
|
+
# IPython
|
|
83
|
+
profile_default/
|
|
84
|
+
ipython_config.py
|
|
85
|
+
|
|
86
|
+
# pyenv
|
|
87
|
+
# For a library or package, you might want to ignore these files since the code is
|
|
88
|
+
# intended to run in multiple environments; otherwise, check them in:
|
|
89
|
+
# .python-version
|
|
90
|
+
|
|
91
|
+
# pipenv
|
|
92
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
|
93
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
|
94
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
|
95
|
+
# install all needed dependencies.
|
|
96
|
+
# Pipfile.lock
|
|
97
|
+
|
|
98
|
+
# uv
|
|
99
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
|
100
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
101
|
+
# commonly ignored for libraries.
|
|
102
|
+
# uv.lock
|
|
103
|
+
|
|
104
|
+
# poetry
|
|
105
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
|
106
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
|
107
|
+
# commonly ignored for libraries.
|
|
108
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
|
109
|
+
# poetry.lock
|
|
110
|
+
# poetry.toml
|
|
111
|
+
|
|
112
|
+
# pdm
|
|
113
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
|
114
|
+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
|
|
115
|
+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
|
|
116
|
+
# pdm.lock
|
|
117
|
+
# pdm.toml
|
|
118
|
+
.pdm-python
|
|
119
|
+
.pdm-build/
|
|
120
|
+
|
|
121
|
+
# pixi
|
|
122
|
+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
|
|
123
|
+
# pixi.lock
|
|
124
|
+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
|
|
125
|
+
# in the .venv directory. It is recommended not to include this directory in version control.
|
|
126
|
+
.pixi/*
|
|
127
|
+
!.pixi/config.toml
|
|
128
|
+
|
|
129
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
|
130
|
+
__pypackages__/
|
|
131
|
+
|
|
132
|
+
# Celery stuff
|
|
133
|
+
celerybeat-schedule*
|
|
134
|
+
celerybeat.pid
|
|
135
|
+
|
|
136
|
+
# Redis
|
|
137
|
+
*.rdb
|
|
138
|
+
*.aof
|
|
139
|
+
*.pid
|
|
140
|
+
|
|
141
|
+
# RabbitMQ
|
|
142
|
+
mnesia/
|
|
143
|
+
rabbitmq/
|
|
144
|
+
rabbitmq-data/
|
|
145
|
+
|
|
146
|
+
# ActiveMQ
|
|
147
|
+
activemq-data/
|
|
148
|
+
|
|
149
|
+
# SageMath parsed files
|
|
150
|
+
*.sage.py
|
|
151
|
+
|
|
152
|
+
# Environments
|
|
153
|
+
.env
|
|
154
|
+
.envrc
|
|
155
|
+
.venv
|
|
156
|
+
env/
|
|
157
|
+
venv/
|
|
158
|
+
ENV/
|
|
159
|
+
env.bak/
|
|
160
|
+
venv.bak/
|
|
161
|
+
|
|
162
|
+
# Spyder project settings
|
|
163
|
+
.spyderproject
|
|
164
|
+
.spyproject
|
|
165
|
+
|
|
166
|
+
# Rope project settings
|
|
167
|
+
.ropeproject
|
|
168
|
+
|
|
169
|
+
# mkdocs/Zensical documentation
|
|
170
|
+
/site
|
|
171
|
+
|
|
172
|
+
# mypy
|
|
173
|
+
.mypy_cache/
|
|
174
|
+
.dmypy.json
|
|
175
|
+
dmypy.json
|
|
176
|
+
|
|
177
|
+
# Pyre type checker
|
|
178
|
+
.pyre/
|
|
179
|
+
|
|
180
|
+
# pytype static type analyzer
|
|
181
|
+
.pytype/
|
|
182
|
+
|
|
183
|
+
# Cython debug symbols
|
|
184
|
+
cython_debug/
|
|
185
|
+
|
|
186
|
+
# PyCharm
|
|
187
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
|
188
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
|
189
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
|
190
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
|
191
|
+
# .idea/
|
|
192
|
+
|
|
193
|
+
# Abstra
|
|
194
|
+
# Abstra is an AI-powered process automation framework.
|
|
195
|
+
# Ignore directories containing user credentials, local state, and settings.
|
|
196
|
+
# Learn more at https://abstra.io/docs
|
|
197
|
+
.abstra/
|
|
198
|
+
|
|
199
|
+
# Visual Studio Code
|
|
200
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
|
|
201
|
+
# can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
|
202
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer, you
|
|
203
|
+
# could uncomment the following to ignore the entire vscode folder
|
|
204
|
+
# .vscode/
|
|
205
|
+
# Temporary file for partial code execution
|
|
206
|
+
tempCodeRunnerFile.py
|
|
207
|
+
|
|
208
|
+
# Ruff stuff:
|
|
209
|
+
.ruff_cache/
|
|
210
|
+
|
|
211
|
+
# PyPI configuration file
|
|
212
|
+
.pypirc
|
|
213
|
+
|
|
214
|
+
# Marimo
|
|
215
|
+
marimo/_static/
|
|
216
|
+
marimo/_lsp/
|
|
217
|
+
__marimo__/
|
|
218
|
+
|
|
219
|
+
# Streamlit
|
|
220
|
+
.streamlit/secrets.toml
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.1.0] - 2026-11-12
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- TUI Pomodoro timer built with Textual and managed by `uv`.
|
|
12
|
+
- Animated ASCII art sprites for a large orange cat and a small tortie cat:
|
|
13
|
+
- Standing next to each other when idle (`IDLE`).
|
|
14
|
+
- Chasing each other across the stage during focus sessions (`FOCUS`).
|
|
15
|
+
- Napping together during short rest breaks (`REST`).
|
|
16
|
+
- Orange cat eating a snack while the tortie plays with a string during long rest breaks (`LONG_REST`).
|
|
17
|
+
- Configurable focus, rest, long rest durations (in minutes) and long rest interval (in completed pomodoros) via CLI flags and the in-app settings modal.
|
|
18
|
+
- GitHub Actions CI, Release (GitHub Releases + PyPI Trusted Publishing), and Dependabot configuration.
|
matchamomo-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Roger Allen
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: matchamomo
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A TUI-based Pomodoro timer featuring two animated ASCII cats: a large orange cat and a small tortie.
|
|
5
|
+
Project-URL: Homepage, https://github.com/Hailstone-Labs/MatchaMomo
|
|
6
|
+
Project-URL: Repository, https://github.com/Hailstone-Labs/MatchaMomo
|
|
7
|
+
Project-URL: Issues, https://github.com/Hailstone-Labs/MatchaMomo/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/Hailstone-Labs/MatchaMomo/blob/main/CHANGELOG.md
|
|
9
|
+
Author-email: Roger Allen <roger.allen795@gmail.com>
|
|
10
|
+
License-Expression: MIT
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: ascii,cats,pomodoro,textual,timer,tui
|
|
13
|
+
Classifier: Development Status :: 4 - Beta
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Intended Audience :: Developers
|
|
16
|
+
Classifier: Intended Audience :: End Users/Desktop
|
|
17
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Topic :: Terminals
|
|
23
|
+
Classifier: Topic :: Utilities
|
|
24
|
+
Requires-Python: >=3.12
|
|
25
|
+
Requires-Dist: textual>=1.0.0
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# MatchaMomo
|
|
29
|
+
|
|
30
|
+
A TUI-based Pomodoro timer built with [Textual](https://textual.textualize.io/) and managed with [`uv`](https://docs.astral.sh/uv/), featuring two animated ASCII cats: a large orange cat and a small tortie.
|
|
31
|
+
|
|
32
|
+
## Features
|
|
33
|
+
|
|
34
|
+
- **Animated ASCII Cats**
|
|
35
|
+
- **Ready (`IDLE`)**: Both cats stand next to each other with subtle tail wags and blinks.
|
|
36
|
+
- **Focus (`FOCUS`)**: When the timer starts, the cats chase each other back and forth across the stage.
|
|
37
|
+
- **Rest (`REST`)**: When focus ends and rest begins, both cats curl up and nap (`zZz`).
|
|
38
|
+
- **Long Rest (`LONG_REST`)**: After a configurable number of completed pomodoros, the large orange cat eats a snack while the small tortie plays with a string.
|
|
39
|
+
- **Configurable Durations (in minutes)**:
|
|
40
|
+
- Focus duration (default: `25` min)
|
|
41
|
+
- Rest duration (default: `5` min)
|
|
42
|
+
- Long rest duration (default: `15` min)
|
|
43
|
+
- Long rest interval (default: every `4` completed pomodoros)
|
|
44
|
+
|
|
45
|
+
## Getting Started
|
|
46
|
+
|
|
47
|
+
Requires Python `>=3.12` and `uv`.
|
|
48
|
+
|
|
49
|
+
```zsh
|
|
50
|
+
# Clone and sync dependencies
|
|
51
|
+
uv sync
|
|
52
|
+
|
|
53
|
+
# Run MatchaMomo with default settings
|
|
54
|
+
uv run matchamomo
|
|
55
|
+
|
|
56
|
+
# Or customize durations via CLI flags
|
|
57
|
+
uv run matchamomo --focus 25 --rest 5 --long-rest 15 --interval 4
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### CLI Options
|
|
61
|
+
|
|
62
|
+
| Flag | Description | Default |
|
|
63
|
+
| --- | --- | --- |
|
|
64
|
+
| `-f`, `--focus` | Focus duration in minutes (`1–180`) | `25` |
|
|
65
|
+
| `-r`, `--rest` | Rest duration in minutes (`1–180`) | `5` |
|
|
66
|
+
| `-l`, `--long-rest` | Long rest duration in minutes (`1–180`) | `15` |
|
|
67
|
+
| `-i`, `--interval` | Completed pomodoros before long rest (`1–20`) | `4` |
|
|
68
|
+
|
|
69
|
+
### Keybindings
|
|
70
|
+
|
|
71
|
+
| Key | Action |
|
|
72
|
+
| --- | --- |
|
|
73
|
+
| `Space` / `s` | Start, pause, or resume timer |
|
|
74
|
+
| `n` | Skip to next phase (e.g., stop focus to rest) |
|
|
75
|
+
| `r` | Reset timer to idle |
|
|
76
|
+
| `c` | Open Timer Settings modal |
|
|
77
|
+
| `+` / `-` | Increase / decrease focus minutes by 1 |
|
|
78
|
+
| `]` / `[` | Increase / decrease rest minutes by 1 |
|
|
79
|
+
| `q` | Quit |
|
|
80
|
+
|
|
81
|
+
## Development
|
|
82
|
+
|
|
83
|
+
```zsh
|
|
84
|
+
# Run tests
|
|
85
|
+
uv run pytest -v
|
|
86
|
+
|
|
87
|
+
# Lint and format check
|
|
88
|
+
uv run ruff check .
|
|
89
|
+
uv run ruff format --check .
|
|
90
|
+
|
|
91
|
+
# Type check
|
|
92
|
+
uv run mypy src tests
|
|
93
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# MatchaMomo
|
|
2
|
+
|
|
3
|
+
A TUI-based Pomodoro timer built with [Textual](https://textual.textualize.io/) and managed with [`uv`](https://docs.astral.sh/uv/), featuring two animated ASCII cats: a large orange cat and a small tortie.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Animated ASCII Cats**
|
|
8
|
+
- **Ready (`IDLE`)**: Both cats stand next to each other with subtle tail wags and blinks.
|
|
9
|
+
- **Focus (`FOCUS`)**: When the timer starts, the cats chase each other back and forth across the stage.
|
|
10
|
+
- **Rest (`REST`)**: When focus ends and rest begins, both cats curl up and nap (`zZz`).
|
|
11
|
+
- **Long Rest (`LONG_REST`)**: After a configurable number of completed pomodoros, the large orange cat eats a snack while the small tortie plays with a string.
|
|
12
|
+
- **Configurable Durations (in minutes)**:
|
|
13
|
+
- Focus duration (default: `25` min)
|
|
14
|
+
- Rest duration (default: `5` min)
|
|
15
|
+
- Long rest duration (default: `15` min)
|
|
16
|
+
- Long rest interval (default: every `4` completed pomodoros)
|
|
17
|
+
|
|
18
|
+
## Getting Started
|
|
19
|
+
|
|
20
|
+
Requires Python `>=3.12` and `uv`.
|
|
21
|
+
|
|
22
|
+
```zsh
|
|
23
|
+
# Clone and sync dependencies
|
|
24
|
+
uv sync
|
|
25
|
+
|
|
26
|
+
# Run MatchaMomo with default settings
|
|
27
|
+
uv run matchamomo
|
|
28
|
+
|
|
29
|
+
# Or customize durations via CLI flags
|
|
30
|
+
uv run matchamomo --focus 25 --rest 5 --long-rest 15 --interval 4
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### CLI Options
|
|
34
|
+
|
|
35
|
+
| Flag | Description | Default |
|
|
36
|
+
| --- | --- | --- |
|
|
37
|
+
| `-f`, `--focus` | Focus duration in minutes (`1–180`) | `25` |
|
|
38
|
+
| `-r`, `--rest` | Rest duration in minutes (`1–180`) | `5` |
|
|
39
|
+
| `-l`, `--long-rest` | Long rest duration in minutes (`1–180`) | `15` |
|
|
40
|
+
| `-i`, `--interval` | Completed pomodoros before long rest (`1–20`) | `4` |
|
|
41
|
+
|
|
42
|
+
### Keybindings
|
|
43
|
+
|
|
44
|
+
| Key | Action |
|
|
45
|
+
| --- | --- |
|
|
46
|
+
| `Space` / `s` | Start, pause, or resume timer |
|
|
47
|
+
| `n` | Skip to next phase (e.g., stop focus to rest) |
|
|
48
|
+
| `r` | Reset timer to idle |
|
|
49
|
+
| `c` | Open Timer Settings modal |
|
|
50
|
+
| `+` / `-` | Increase / decrease focus minutes by 1 |
|
|
51
|
+
| `]` / `[` | Increase / decrease rest minutes by 1 |
|
|
52
|
+
| `q` | Quit |
|
|
53
|
+
|
|
54
|
+
## Development
|
|
55
|
+
|
|
56
|
+
```zsh
|
|
57
|
+
# Run tests
|
|
58
|
+
uv run pytest -v
|
|
59
|
+
|
|
60
|
+
# Lint and format check
|
|
61
|
+
uv run ruff check .
|
|
62
|
+
uv run ruff format --check .
|
|
63
|
+
|
|
64
|
+
# Type check
|
|
65
|
+
uv run mypy src tests
|
|
66
|
+
```
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "matchamomo"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "A TUI-based Pomodoro timer featuring two animated ASCII cats: a large orange cat and a small tortie."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
license = "MIT"
|
|
7
|
+
authors = [
|
|
8
|
+
{ name = "Roger Allen", email = "roger.allen795@gmail.com" },
|
|
9
|
+
]
|
|
10
|
+
keywords = ["pomodoro", "timer", "tui", "textual", "cats", "ascii"]
|
|
11
|
+
classifiers = [
|
|
12
|
+
"Development Status :: 4 - Beta",
|
|
13
|
+
"Environment :: Console",
|
|
14
|
+
"Intended Audience :: Developers",
|
|
15
|
+
"Intended Audience :: End Users/Desktop",
|
|
16
|
+
"License :: OSI Approved :: MIT License",
|
|
17
|
+
"Operating System :: OS Independent",
|
|
18
|
+
"Programming Language :: Python :: 3",
|
|
19
|
+
"Programming Language :: Python :: 3.12",
|
|
20
|
+
"Programming Language :: Python :: 3.13",
|
|
21
|
+
"Topic :: Terminals",
|
|
22
|
+
"Topic :: Utilities",
|
|
23
|
+
]
|
|
24
|
+
requires-python = ">=3.12"
|
|
25
|
+
dependencies = [
|
|
26
|
+
"textual>=1.0.0",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Homepage = "https://github.com/Hailstone-Labs/MatchaMomo"
|
|
31
|
+
Repository = "https://github.com/Hailstone-Labs/MatchaMomo"
|
|
32
|
+
Issues = "https://github.com/Hailstone-Labs/MatchaMomo/issues"
|
|
33
|
+
Changelog = "https://github.com/Hailstone-Labs/MatchaMomo/blob/main/CHANGELOG.md"
|
|
34
|
+
|
|
35
|
+
[project.scripts]
|
|
36
|
+
matchamomo = "matchamomo.__main__:main"
|
|
37
|
+
|
|
38
|
+
[build-system]
|
|
39
|
+
requires = ["hatchling"]
|
|
40
|
+
build-backend = "hatchling.build"
|
|
41
|
+
|
|
42
|
+
[tool.hatch.build.targets.wheel]
|
|
43
|
+
packages = ["src/matchamomo"]
|
|
44
|
+
|
|
45
|
+
[dependency-groups]
|
|
46
|
+
dev = [
|
|
47
|
+
"mypy>=1.11.0",
|
|
48
|
+
"pytest>=8.0.0",
|
|
49
|
+
"pytest-asyncio>=0.24.0",
|
|
50
|
+
"ruff>=0.7.0",
|
|
51
|
+
]
|
|
52
|
+
|
|
53
|
+
[tool.pytest.ini_options]
|
|
54
|
+
testpaths = ["tests"]
|
|
55
|
+
asyncio_mode = "auto"
|
|
56
|
+
|
|
57
|
+
[tool.ruff]
|
|
58
|
+
target-version = "py312"
|
|
59
|
+
line-length = 100
|
|
60
|
+
|
|
61
|
+
[tool.ruff.lint]
|
|
62
|
+
select = ["E", "F", "I", "UP", "B"]
|
|
63
|
+
|
|
64
|
+
[tool.mypy]
|
|
65
|
+
python_version = "3.12"
|
|
66
|
+
strict = false
|
|
67
|
+
warn_unused_ignores = true
|
|
68
|
+
warn_redundant_casts = true
|
|
69
|
+
check_untyped_defs = true
|