tame-tasks 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.
- tame_tasks-0.1.0/.gitattributes +1 -0
- tame_tasks-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md +21 -0
- tame_tasks-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md +11 -0
- tame_tasks-0.1.0/.github/pull_request_template.md +11 -0
- tame_tasks-0.1.0/.github/workflows/ci.yml +67 -0
- tame_tasks-0.1.0/.github/workflows/docs.yml +58 -0
- tame_tasks-0.1.0/.github/workflows/release.yml +70 -0
- tame_tasks-0.1.0/.gitignore +17 -0
- tame_tasks-0.1.0/.pre-commit-config.yaml +28 -0
- tame_tasks-0.1.0/.python-version +1 -0
- tame_tasks-0.1.0/CHANGELOG.md +51 -0
- tame_tasks-0.1.0/CLAUDE.md +19 -0
- tame_tasks-0.1.0/CONTRIBUTING.md +80 -0
- tame_tasks-0.1.0/LICENSE +21 -0
- tame_tasks-0.1.0/PKG-INFO +154 -0
- tame_tasks-0.1.0/README.md +126 -0
- tame_tasks-0.1.0/docs/SPEC.md +234 -0
- tame_tasks-0.1.0/docs/commands.md +221 -0
- tame_tasks-0.1.0/docs/getting-started.md +102 -0
- tame_tasks-0.1.0/docs/grammar.md +95 -0
- tame_tasks-0.1.0/docs/index.md +57 -0
- tame_tasks-0.1.0/docs/install-beginners.md +62 -0
- tame_tasks-0.1.0/docs/install.ps1 +36 -0
- tame_tasks-0.1.0/docs/install.sh +27 -0
- tame_tasks-0.1.0/docs/settings.md +65 -0
- tame_tasks-0.1.0/docs/taskwarrior.md +77 -0
- tame_tasks-0.1.0/docs/urgency.md +45 -0
- tame_tasks-0.1.0/mkdocs.yml +51 -0
- tame_tasks-0.1.0/pyproject.toml +114 -0
- tame_tasks-0.1.0/release-notes.md +59 -0
- tame_tasks-0.1.0/scripts/release_notes.py +60 -0
- tame_tasks-0.1.0/scripts/smoke.py +76 -0
- tame_tasks-0.1.0/scripts/spoilers.py +54 -0
- tame_tasks-0.1.0/scripts/tk.ps1 +25 -0
- tame_tasks-0.1.0/scripts/tk.sh +18 -0
- tame_tasks-0.1.0/src/tame/__init__.py +3 -0
- tame_tasks-0.1.0/src/tame/__main__.py +55 -0
- tame_tasks-0.1.0/src/tame/alias.py +134 -0
- tame_tasks-0.1.0/src/tame/cli/__init__.py +1 -0
- tame_tasks-0.1.0/src/tame/cli/commands.py +468 -0
- tame_tasks-0.1.0/src/tame/cli/eggs.py +79 -0
- tame_tasks-0.1.0/src/tame/cli/parser.py +360 -0
- tame_tasks-0.1.0/src/tame/cli/render.py +176 -0
- tame_tasks-0.1.0/src/tame/config.py +416 -0
- tame_tasks-0.1.0/src/tame/core/__init__.py +1 -0
- tame_tasks-0.1.0/src/tame/core/dates.py +109 -0
- tame_tasks-0.1.0/src/tame/core/filters.py +78 -0
- tame_tasks-0.1.0/src/tame/core/models.py +151 -0
- tame_tasks-0.1.0/src/tame/core/service.py +272 -0
- tame_tasks-0.1.0/src/tame/core/urgency.py +68 -0
- tame_tasks-0.1.0/src/tame/errors.py +53 -0
- tame_tasks-0.1.0/src/tame/i18n.py +79 -0
- tame_tasks-0.1.0/src/tame/io/__init__.py +1 -0
- tame_tasks-0.1.0/src/tame/io/tw_json.py +183 -0
- tame_tasks-0.1.0/src/tame/locales/en.toml +410 -0
- tame_tasks-0.1.0/src/tame/locales/fr.toml +420 -0
- tame_tasks-0.1.0/src/tame/py.typed +0 -0
- tame_tasks-0.1.0/src/tame/storage/__init__.py +1 -0
- tame_tasks-0.1.0/src/tame/storage/migrations.py +79 -0
- tame_tasks-0.1.0/src/tame/storage/repo.py +294 -0
- tame_tasks-0.1.0/tests/cli/test_eggs.py +110 -0
- tame_tasks-0.1.0/tests/cli/test_parser.py +394 -0
- tame_tasks-0.1.0/tests/cli/test_render.py +79 -0
- tame_tasks-0.1.0/tests/conftest.py +54 -0
- tame_tasks-0.1.0/tests/core/test_dates.py +92 -0
- tame_tasks-0.1.0/tests/core/test_filters.py +132 -0
- tame_tasks-0.1.0/tests/core/test_models.py +56 -0
- tame_tasks-0.1.0/tests/core/test_service.py +343 -0
- tame_tasks-0.1.0/tests/core/test_urgency.py +76 -0
- tame_tasks-0.1.0/tests/io/test_tw_json.py +229 -0
- tame_tasks-0.1.0/tests/storage/test_migrations.py +66 -0
- tame_tasks-0.1.0/tests/storage/test_repo.py +216 -0
- tame_tasks-0.1.0/tests/test_alias.py +123 -0
- tame_tasks-0.1.0/tests/test_config.py +224 -0
- tame_tasks-0.1.0/tests/test_i18n.py +110 -0
- tame_tasks-0.1.0/tests/test_main.py +900 -0
- tame_tasks-0.1.0/tests/test_release_notes.py +57 -0
- tame_tasks-0.1.0/uv.lock +1230 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
* text=auto eol=lf
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Bug report
|
|
3
|
+
about: Something does not work as described in the docs or spec
|
|
4
|
+
labels: bug
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
**Command run**
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
tk ...
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
**Expected behavior**
|
|
14
|
+
|
|
15
|
+
**Actual behavior** (output, exit code)
|
|
16
|
+
|
|
17
|
+
**Environment**
|
|
18
|
+
|
|
19
|
+
- `tame version`:
|
|
20
|
+
- OS:
|
|
21
|
+
- Installed with (installer script, `uv tool install tame-tasks`, git):
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
## Summary
|
|
2
|
+
|
|
3
|
+
<!-- What does this PR change, and which roadmap step / issue does it address? -->
|
|
4
|
+
|
|
5
|
+
## Checklist
|
|
6
|
+
|
|
7
|
+
- [ ] Tests added or updated (spec examples covered)
|
|
8
|
+
- [ ] `uv run ruff check`, `ruff format --check`, `mypy`, `pytest` pass locally
|
|
9
|
+
- [ ] Docstrings and docs (`README.md`, `docs/`) match the new behavior
|
|
10
|
+
- [ ] `CHANGELOG.md` updated under `[Unreleased]`
|
|
11
|
+
- [ ] `docs/SPEC.md` updated if behavior differs from the spec
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
concurrency:
|
|
9
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
10
|
+
cancel-in-progress: true
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
check:
|
|
14
|
+
name: ${{ matrix.os }} / py${{ matrix.python }}
|
|
15
|
+
runs-on: ${{ matrix.os }}
|
|
16
|
+
strategy:
|
|
17
|
+
fail-fast: false
|
|
18
|
+
matrix:
|
|
19
|
+
os: [windows-latest, ubuntu-latest]
|
|
20
|
+
python: ["3.12", "3.14"]
|
|
21
|
+
env:
|
|
22
|
+
UV_PYTHON: ${{ matrix.python }}
|
|
23
|
+
steps:
|
|
24
|
+
- uses: actions/checkout@v5
|
|
25
|
+
- uses: astral-sh/setup-uv@v7
|
|
26
|
+
with:
|
|
27
|
+
enable-cache: true
|
|
28
|
+
- name: Install
|
|
29
|
+
run: uv sync --locked
|
|
30
|
+
- name: Lint
|
|
31
|
+
run: uv run ruff check --output-format=github
|
|
32
|
+
- name: Format
|
|
33
|
+
run: uv run ruff format --check
|
|
34
|
+
- name: Types
|
|
35
|
+
run: uv run mypy
|
|
36
|
+
- name: Tests
|
|
37
|
+
run: uv run pytest --cov --cov-report=term-missing
|
|
38
|
+
- name: Coverage summary
|
|
39
|
+
if: ${{ !cancelled() }}
|
|
40
|
+
shell: bash
|
|
41
|
+
run: |
|
|
42
|
+
echo "### Coverage (${{ matrix.os }}, Python ${{ matrix.python }})" >> "$GITHUB_STEP_SUMMARY"
|
|
43
|
+
uv run coverage report --format=markdown >> "$GITHUB_STEP_SUMMARY" || true
|
|
44
|
+
|
|
45
|
+
install:
|
|
46
|
+
name: install / ${{ matrix.os }}
|
|
47
|
+
runs-on: ${{ matrix.os }}
|
|
48
|
+
strategy:
|
|
49
|
+
fail-fast: false
|
|
50
|
+
matrix:
|
|
51
|
+
os: [windows-latest, ubuntu-latest]
|
|
52
|
+
defaults:
|
|
53
|
+
run:
|
|
54
|
+
shell: bash
|
|
55
|
+
steps:
|
|
56
|
+
- uses: actions/checkout@v5
|
|
57
|
+
- uses: astral-sh/setup-uv@v7
|
|
58
|
+
- name: Use throwaway tool directories
|
|
59
|
+
run: |
|
|
60
|
+
echo "UV_TOOL_DIR=$RUNNER_TEMP/uv-tools" >> "$GITHUB_ENV"
|
|
61
|
+
echo "UV_TOOL_BIN_DIR=$RUNNER_TEMP/uv-bin" >> "$GITHUB_ENV"
|
|
62
|
+
- name: Build
|
|
63
|
+
run: uv build
|
|
64
|
+
- name: Install the wheel as a uv tool
|
|
65
|
+
run: uv tool install dist/*.whl
|
|
66
|
+
- name: Smoke test
|
|
67
|
+
run: uv run --no-project python scripts/smoke.py "$UV_TOOL_BIN_DIR"
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
name: Docs
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
workflow_dispatch:
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
11
|
+
cancel-in-progress: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
build:
|
|
15
|
+
name: build site
|
|
16
|
+
runs-on: ubuntu-latest
|
|
17
|
+
env:
|
|
18
|
+
NO_MKDOCS_2_WARNING: "1"
|
|
19
|
+
steps:
|
|
20
|
+
- uses: actions/checkout@v5
|
|
21
|
+
- uses: astral-sh/setup-uv@v7
|
|
22
|
+
with:
|
|
23
|
+
enable-cache: true
|
|
24
|
+
- name: Install
|
|
25
|
+
run: uv sync --locked --group docs
|
|
26
|
+
- name: Build site
|
|
27
|
+
run: uv run mkdocs build --strict
|
|
28
|
+
- name: Coverage badge
|
|
29
|
+
# shields.io endpoint read by the README badge.
|
|
30
|
+
run: |
|
|
31
|
+
uv run pytest -q --cov --cov-report=json:coverage.json
|
|
32
|
+
mkdir -p site/badges
|
|
33
|
+
uv run python - <<'EOF'
|
|
34
|
+
import json
|
|
35
|
+
percent = json.load(open("coverage.json"))["totals"]["percent_covered"]
|
|
36
|
+
color = "brightgreen" if percent >= 95 else "green" if percent >= 90 else "red"
|
|
37
|
+
badge = {"schemaVersion": 1, "label": "coverage", "message": f"{percent:.0f}%", "color": color}
|
|
38
|
+
json.dump(badge, open("site/badges/coverage.json", "w"))
|
|
39
|
+
EOF
|
|
40
|
+
- uses: actions/upload-pages-artifact@v4
|
|
41
|
+
if: github.ref == 'refs/heads/main'
|
|
42
|
+
with:
|
|
43
|
+
path: site
|
|
44
|
+
|
|
45
|
+
deploy:
|
|
46
|
+
name: deploy to GitHub Pages
|
|
47
|
+
if: github.ref == 'refs/heads/main'
|
|
48
|
+
needs: build
|
|
49
|
+
runs-on: ubuntu-latest
|
|
50
|
+
permissions:
|
|
51
|
+
pages: write
|
|
52
|
+
id-token: write
|
|
53
|
+
environment:
|
|
54
|
+
name: github-pages
|
|
55
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
56
|
+
steps:
|
|
57
|
+
- id: deployment
|
|
58
|
+
uses: actions/deploy-pages@v4
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
name: Release
|
|
2
|
+
|
|
3
|
+
# Push a tag vX.Y.Z (matching __version__ and a CHANGELOG section) to publish:
|
|
4
|
+
# build and check -> PyPI (needs approval in the "pypi" environment) -> GitHub release.
|
|
5
|
+
|
|
6
|
+
on:
|
|
7
|
+
push:
|
|
8
|
+
tags: ["v*"]
|
|
9
|
+
|
|
10
|
+
jobs:
|
|
11
|
+
build:
|
|
12
|
+
name: build and check
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v5
|
|
16
|
+
- uses: astral-sh/setup-uv@v7
|
|
17
|
+
- name: Tag matches the package version
|
|
18
|
+
run: |
|
|
19
|
+
version=$(uv run --no-project python -c "import re,pathlib; print(re.search(r'__version__ = \"(.+)\"', pathlib.Path('src/tame/__init__.py').read_text())[1])")
|
|
20
|
+
echo "tag=${GITHUB_REF_NAME} version=${version}"
|
|
21
|
+
test "${GITHUB_REF_NAME}" = "v${version}"
|
|
22
|
+
- name: Release notes
|
|
23
|
+
run: uv run --no-project python scripts/release_notes.py "${GITHUB_REF_NAME}" > release-notes.md
|
|
24
|
+
- name: Build
|
|
25
|
+
run: uv build
|
|
26
|
+
- name: Smoke test the wheel
|
|
27
|
+
run: |
|
|
28
|
+
export UV_TOOL_DIR="$RUNNER_TEMP/uv-tools" UV_TOOL_BIN_DIR="$RUNNER_TEMP/uv-bin"
|
|
29
|
+
uv tool install dist/*.whl
|
|
30
|
+
uv run --no-project python scripts/smoke.py "$UV_TOOL_BIN_DIR"
|
|
31
|
+
- uses: actions/upload-artifact@v5
|
|
32
|
+
with:
|
|
33
|
+
name: release
|
|
34
|
+
path: |
|
|
35
|
+
dist/
|
|
36
|
+
release-notes.md
|
|
37
|
+
|
|
38
|
+
pypi:
|
|
39
|
+
name: publish to PyPI
|
|
40
|
+
needs: build
|
|
41
|
+
runs-on: ubuntu-latest
|
|
42
|
+
environment:
|
|
43
|
+
name: pypi
|
|
44
|
+
url: https://pypi.org/project/tame-tasks/
|
|
45
|
+
permissions:
|
|
46
|
+
id-token: write # trusted publishing: no token stored anywhere
|
|
47
|
+
steps:
|
|
48
|
+
- uses: actions/download-artifact@v5
|
|
49
|
+
with:
|
|
50
|
+
name: release
|
|
51
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
52
|
+
|
|
53
|
+
github:
|
|
54
|
+
name: GitHub release
|
|
55
|
+
needs: pypi
|
|
56
|
+
runs-on: ubuntu-latest
|
|
57
|
+
permissions:
|
|
58
|
+
contents: write
|
|
59
|
+
steps:
|
|
60
|
+
- uses: actions/download-artifact@v5
|
|
61
|
+
with:
|
|
62
|
+
name: release
|
|
63
|
+
- name: Create the release
|
|
64
|
+
env:
|
|
65
|
+
GH_TOKEN: ${{ github.token }}
|
|
66
|
+
run: >
|
|
67
|
+
gh release create "$GITHUB_REF_NAME" dist/*
|
|
68
|
+
--repo "$GITHUB_REPOSITORY"
|
|
69
|
+
--title "TAME $GITHUB_REF_NAME"
|
|
70
|
+
--notes-file release-notes.md
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
repos:
|
|
2
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
3
|
+
rev: v6.0.0
|
|
4
|
+
hooks:
|
|
5
|
+
- id: end-of-file-fixer
|
|
6
|
+
- id: trailing-whitespace
|
|
7
|
+
- id: check-toml
|
|
8
|
+
- id: check-yaml
|
|
9
|
+
|
|
10
|
+
# Use the versions pinned in uv.lock so hooks and CI always agree.
|
|
11
|
+
- repo: local
|
|
12
|
+
hooks:
|
|
13
|
+
- id: ruff-check
|
|
14
|
+
name: ruff check
|
|
15
|
+
entry: uv run ruff check --fix
|
|
16
|
+
language: system
|
|
17
|
+
types_or: [python, pyi]
|
|
18
|
+
- id: ruff-format
|
|
19
|
+
name: ruff format
|
|
20
|
+
entry: uv run ruff format
|
|
21
|
+
language: system
|
|
22
|
+
types_or: [python, pyi]
|
|
23
|
+
- id: mypy
|
|
24
|
+
name: mypy
|
|
25
|
+
entry: uv run mypy
|
|
26
|
+
language: system
|
|
27
|
+
types_or: [python, pyi]
|
|
28
|
+
pass_filenames: false
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12
|
|
@@ -0,0 +1,51 @@
|
|
|
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
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [0.1.0] - 2026-11-19
|
|
11
|
+
|
|
12
|
+
First release: a small, fast to-do list for the terminal, Windows first, Taskwarrior-friendly.
|
|
13
|
+
|
|
14
|
+
### Tasks
|
|
15
|
+
|
|
16
|
+
- `add`, `list`, `info`, `modify`, `done`, `delete` (kept, with `status:deleted`), `undo`
|
|
17
|
+
(any number of steps back, ids included).
|
|
18
|
+
- Attributes: description, project (dotted: `home.garden`), tags, priority H/M/L, due date.
|
|
19
|
+
- Dates in plain English: `today`, `tomorrow`, `fri`, `eow`, `eom`, `eoy`, `+3d`, `+2w`,
|
|
20
|
+
or ISO `2026-12-15`.
|
|
21
|
+
- Urgency: priority, due date, age, tags and project add up; `list` shows the most urgent
|
|
22
|
+
first (pending tasks first when statuses are mixed). Overdue tasks red, due today yellow.
|
|
23
|
+
- Confirmation before bulk changes (`delete` always asks); `--yes` skips it.
|
|
24
|
+
|
|
25
|
+
### Command line
|
|
26
|
+
|
|
27
|
+
- Taskwarrior-style grammar: filter before the command (`tk +phone list`) or after it;
|
|
28
|
+
short command prefixes (`tk mod`); `tk` alone lists tasks.
|
|
29
|
+
- Filters: ids (`3`, `3,5`, `2-6`), uuid prefixes, `+tag`/`-tag`, `project:`, `pri:`,
|
|
30
|
+
`status:` (including `status:all`), `due.before:`/`due.after:`, description words.
|
|
31
|
+
|
|
32
|
+
### Taskwarrior
|
|
33
|
+
|
|
34
|
+
- `export` / `import` in Taskwarrior JSON, merged by uuid; attributes TAME does not use
|
|
35
|
+
(annotations, recurrence, UDAs…) are kept and exported back.
|
|
36
|
+
- `tk alias install task`: opt-in `task` command.
|
|
37
|
+
|
|
38
|
+
### Comfort
|
|
39
|
+
|
|
40
|
+
- English or French interface (`tk config set language fr`).
|
|
41
|
+
- Settings in `config.toml`, managed with `tk config`.
|
|
42
|
+
- Help for every command (`tk help`, `tk <command> --help`), topics, and a two-minute
|
|
43
|
+
guided tour (`tk help tour`); a welcome on first run.
|
|
44
|
+
- One-line installers for Windows and Linux: no Python needed.
|
|
45
|
+
- A few hidden easter eggs.
|
|
46
|
+
|
|
47
|
+
### Project
|
|
48
|
+
|
|
49
|
+
- Documentation site: https://skitourer.github.io/tame/
|
|
50
|
+
- Published on PyPI as `tame-tasks`; commands `tame` and `tk`.
|
|
51
|
+
- CI on Windows and Linux (lint, types, tests with a 90 % coverage gate, install check).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
Project: TAME, lightweight Taskwarrior-like CLI (Python 3.12, SQLite, Windows 11 first).
|
|
4
|
+
Source of truth: `docs/SPEC.md`. Read the relevant section before coding; do not re-read it all each time.
|
|
5
|
+
|
|
6
|
+
## Language
|
|
7
|
+
- Talk to the user in French.
|
|
8
|
+
- Code, comments, docstrings, commits, docs, spec: English.
|
|
9
|
+
|
|
10
|
+
## Rules
|
|
11
|
+
- Follow SPEC §2 standards: uv, src layout, ruff, mypy --strict, pytest, Conventional Commits.
|
|
12
|
+
- Respect layers (SPEC §8): `core`/`storage` never print, never read argv, never import rich.
|
|
13
|
+
- All user-facing text via `t()`; add keys to `locales/en.toml`.
|
|
14
|
+
- Every new behavior gets tests; spec examples become tests.
|
|
15
|
+
- One roadmap step = one branch + one PR. Run `uv run ruff check`, `uv run ruff format`, `uv run mypy src`, `uv run pytest` before proposing a commit.
|
|
16
|
+
- No author attribution in commit messages or PR descriptions: no `Co-Authored-By`, no "Generated with", no names.
|
|
17
|
+
- Spec change needed? Propose it to the user first, then update `docs/SPEC.md` in the same PR.
|
|
18
|
+
- Before any release: apply the release checklist (SPEC §8). Docs must match behavior.
|
|
19
|
+
- Keep answers short; show diffs, not whole files, unless creating one.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
# Contributing to TAME
|
|
2
|
+
|
|
3
|
+
The specification in [docs/SPEC.md](docs/SPEC.md) is the source of truth. Read the relevant
|
|
4
|
+
section before changing behavior; propose spec changes in the same PR as the code.
|
|
5
|
+
|
|
6
|
+
## Setup
|
|
7
|
+
|
|
8
|
+
Requires [uv](https://docs.astral.sh/uv/).
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
git clone https://github.com/skitourer/tame
|
|
12
|
+
cd tame
|
|
13
|
+
uv sync
|
|
14
|
+
uv run pre-commit install
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Run the CLI from the checkout with `uv run tame <args>` (or `uv run tk <args>`).
|
|
18
|
+
|
|
19
|
+
To try it without touching your real tasks, use the sandbox scripts: they keep tasks,
|
|
20
|
+
settings and aliases in `.sandbox/` (ignored by git).
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
.\scripts\tk.ps1 add Call bank +phone due:fri # PowerShell; quote '--'
|
|
24
|
+
./scripts/tk.sh add Call bank +phone due:fri # sh
|
|
25
|
+
.\scripts\tk.ps1 --reset # start over
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
To check a real install (what CI's `install` job does): build, install as a uv tool in
|
|
29
|
+
throwaway directories, then run `python scripts/smoke.py <tool bin dir>`.
|
|
30
|
+
|
|
31
|
+
Documentation site (MkDocs Material, deployed to GitHub Pages from `main`):
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
uv run --group docs mkdocs serve # preview at http://127.0.0.1:8000
|
|
35
|
+
uv run --group docs mkdocs build --strict
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Easter eggs are hidden in the code and tests (hashed triggers, ROT13 replies). To list
|
|
39
|
+
them: `uv run python scripts/spoilers.py` (spoilers!).
|
|
40
|
+
|
|
41
|
+
## Checks
|
|
42
|
+
|
|
43
|
+
All of these must pass before opening a PR (CI runs them on Windows and Linux):
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
uv run ruff check
|
|
47
|
+
uv run ruff format --check
|
|
48
|
+
uv run mypy
|
|
49
|
+
uv run pytest --cov
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Conventions
|
|
53
|
+
|
|
54
|
+
- **Python 3.12** baseline, full type hints, `mypy --strict`.
|
|
55
|
+
- **Layers** (SPEC §8): `cli` → `core.service` → `storage`. `core` and `storage` never print,
|
|
56
|
+
never read `argv` and never import `rich`.
|
|
57
|
+
- **Docstrings**: Google style on public modules, classes and functions.
|
|
58
|
+
- **Tests**: every new behavior gets tests; every example in the spec becomes a test.
|
|
59
|
+
- **User-facing text** goes through `t()` with keys in `src/tame/locales/en.toml`, the
|
|
60
|
+
reference, translated in `fr.toml` (a test checks both have the same keys and
|
|
61
|
+
placeholders).
|
|
62
|
+
|
|
63
|
+
## Git workflow
|
|
64
|
+
|
|
65
|
+
- `main` is protected: work on a branch, one roadmap step per branch and PR.
|
|
66
|
+
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
|
|
67
|
+
(`feat:`, `fix:`, `docs:`, `test:`, `refactor:`, `chore:`, `ci:`…).
|
|
68
|
+
- Update [CHANGELOG.md](CHANGELOG.md) under `[Unreleased]` for user-visible changes.
|
|
69
|
+
|
|
70
|
+
## Releases
|
|
71
|
+
|
|
72
|
+
Versions follow [SemVer](https://semver.org/) and are tagged `vX.Y.Z`. Apply the release checklist
|
|
73
|
+
in SPEC §8 before every release, then:
|
|
74
|
+
|
|
75
|
+
1. In a PR: set `__version__` in `src/tame/__init__.py`, rename `[Unreleased]` in the
|
|
76
|
+
CHANGELOG to `[X.Y.Z] - YYYY-MM-DD` (its text becomes the release notes), merge.
|
|
77
|
+
2. Tag `main`: `git tag vX.Y.Z && git push origin vX.Y.Z`.
|
|
78
|
+
3. The Release workflow builds and smoke-tests the package, then waits: approve the
|
|
79
|
+
`pypi` deployment in the Actions tab. It publishes to PyPI (`tame-tasks`) and creates
|
|
80
|
+
the GitHub release.
|
tame_tasks-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Skitourer
|
|
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,154 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: tame-tasks
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: TAME Arranges My Errands: a lightweight Taskwarrior-like CLI task manager.
|
|
5
|
+
Project-URL: Homepage, https://skitourer.github.io/tame/
|
|
6
|
+
Project-URL: Documentation, https://skitourer.github.io/tame/
|
|
7
|
+
Project-URL: Source, https://github.com/Skitourer/tame
|
|
8
|
+
Project-URL: Issues, https://github.com/Skitourer/tame/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/Skitourer/tame/blob/main/CHANGELOG.md
|
|
10
|
+
Author: Skitourer
|
|
11
|
+
License-Expression: MIT
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: cli,task-manager,tasks,taskwarrior,todo
|
|
14
|
+
Classifier: Development Status :: 3 - Alpha
|
|
15
|
+
Classifier: Environment :: Console
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
22
|
+
Classifier: Typing :: Typed
|
|
23
|
+
Requires-Python: >=3.12
|
|
24
|
+
Requires-Dist: python-dateutil>=2.9
|
|
25
|
+
Requires-Dist: rich>=13.9
|
|
26
|
+
Requires-Dist: tomlkit>=0.13
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# TAME
|
|
30
|
+
|
|
31
|
+
[](https://github.com/Skitourer/tame/actions/workflows/ci.yml)
|
|
32
|
+
[](https://github.com/Skitourer/tame/actions/workflows/docs.yml)
|
|
33
|
+
[](https://skitourer.github.io/tame/)
|
|
34
|
+
[](pyproject.toml)
|
|
35
|
+
[](LICENSE)
|
|
36
|
+
[](https://github.com/astral-sh/ruff)
|
|
37
|
+
[](https://mypy-lang.org/)
|
|
38
|
+
|
|
39
|
+
**TAME Arranges My Errands.** A small, fast to-do list for your terminal: add a task in one
|
|
40
|
+
line, see what matters most, tick it off, move on.
|
|
41
|
+
|
|
42
|
+
```text
|
|
43
|
+
> tk add Call the bank +phone due:fri pri:H
|
|
44
|
+
Created task 1.
|
|
45
|
+
> tk add Water the plants project:home
|
|
46
|
+
Created task 2.
|
|
47
|
+
> tk
|
|
48
|
+
ID Age Project Tags Pri Due Description Urg
|
|
49
|
+
───────────────────────────────────────────────────────────────────────
|
|
50
|
+
1 5s phone H 2026-11-20 Call the bank 15.8
|
|
51
|
+
2 3s home Water the plants 1.0
|
|
52
|
+
> tk 1 done
|
|
53
|
+
Completed task 1 'Call the bank'.
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
- **Quick to type**: `tk` lists your tasks, `tk 3 done` completes one, commands shorten
|
|
57
|
+
(`tk mod`), and dates speak plain English: `due:fri`, `due:eom`, `due:+2w`.
|
|
58
|
+
- **Most urgent first**: priority, due date, age, tags and project add up to an urgency
|
|
59
|
+
score, so the top of the list is what to do now.
|
|
60
|
+
- **Forgiving**: `tk undo` reverts any change, bulk changes ask first, deleted tasks are
|
|
61
|
+
kept.
|
|
62
|
+
- **Windows first**, at home on Linux too. English or French interface.
|
|
63
|
+
- **Taskwarrior-friendly**: same grammar spirit, and its JSON imports and exports both ways.
|
|
64
|
+
|
|
65
|
+
> Status: alpha (0.1). Everything described here works; details may still change before
|
|
66
|
+
> 1.0. See the roadmap in
|
|
67
|
+
> [docs/SPEC.md](docs/SPEC.md#8-layout-quality-release).
|
|
68
|
+
|
|
69
|
+
## Install
|
|
70
|
+
|
|
71
|
+
On Windows, paste this in PowerShell. No Python needed: it installs
|
|
72
|
+
[uv](https://docs.astral.sh/uv/), which brings its own Python, then TAME.
|
|
73
|
+
|
|
74
|
+
```powershell
|
|
75
|
+
irm https://skitourer.github.io/tame/install.ps1 | iex
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
On Linux: `curl -LsSf https://skitourer.github.io/tame/install.sh | sh`. Step by step:
|
|
79
|
+
[Installation for beginners](https://skitourer.github.io/tame/install-beginners/).
|
|
80
|
+
|
|
81
|
+
Already using uv?
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
uv tool install tame-tasks
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
This installs two commands: `tame` and its short alias `tk`. Run `tk` to get started, or take
|
|
88
|
+
the two-minute tour: `tk help tour`. Full documentation: **https://skitourer.github.io/tame/**.
|
|
89
|
+
|
|
90
|
+
## Usage
|
|
91
|
+
|
|
92
|
+
```sh
|
|
93
|
+
tk add Call bank project:home +phone due:fri pri:H # Created task 1.
|
|
94
|
+
tk add -- done the report # everything after -- is description
|
|
95
|
+
tk list # most urgent first; or just: tk
|
|
96
|
+
tk due.before:eow # due before the end of the week
|
|
97
|
+
tk project:home list # filter first (or: tk list project:home)
|
|
98
|
+
tk +phone -work bank # tags and description words
|
|
99
|
+
tk 2-6 pri:H # ids and priority
|
|
100
|
+
tk 3,5 done # complete tasks 3 and 5
|
|
101
|
+
tk 4 delete # asks first; --yes skips the question
|
|
102
|
+
tk 1 modify due:+3d -phone Call the bank # set, untag, new description
|
|
103
|
+
tk 7 info # every field
|
|
104
|
+
tk undo # revert the last change (repeat to go back)
|
|
105
|
+
tk status:all export > backup.json # Taskwarrior JSON; status:all = every task
|
|
106
|
+
tk import tw.json # from Taskwarrior (task export > tw.json)
|
|
107
|
+
tk alias install task # opt-in: also run tame as `task`
|
|
108
|
+
tk help # commands; tk help <command|topic>
|
|
109
|
+
tk modify --help # same as: tk help modify
|
|
110
|
+
tk version
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Filter syntax and parsing rules: [docs/grammar.md](docs/grammar.md).
|
|
114
|
+
|
|
115
|
+
Tasks are stored in `%APPDATA%\tame\tasks.db` on Windows and `~/.local/share/tame/tasks.db` on
|
|
116
|
+
Linux (`$XDG_DATA_HOME` is honored). Set `TAME_HOME` to use another directory.
|
|
117
|
+
|
|
118
|
+
## Settings
|
|
119
|
+
|
|
120
|
+
Settings live in `config.toml`, next to `tasks.db` on Windows (`~/.config/tame` on Linux). It is
|
|
121
|
+
created on first run, with every option and a comment. Edit it by hand, or:
|
|
122
|
+
|
|
123
|
+
```sh
|
|
124
|
+
tk config # list settings; changed ones show their default
|
|
125
|
+
tk config set language fr # French interface (commands stay in English)
|
|
126
|
+
tk config set undo.retention 1y # keep undo history one year (default 3m; or forever)
|
|
127
|
+
tk config set confirm_threshold 5 # ask before changing more than 5 tasks
|
|
128
|
+
tk config set date_format %d/%m/%Y
|
|
129
|
+
tk config unset date_format # back to the default
|
|
130
|
+
tk config get color
|
|
131
|
+
tk config edit # open in $EDITOR (Notepad on Windows)
|
|
132
|
+
tk config path
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Other options: `color`, and the urgency weights `urgency.pri_H`, `urgency.due`...
|
|
136
|
+
|
|
137
|
+
See [docs/SPEC.md](docs/SPEC.md) for the full specification.
|
|
138
|
+
|
|
139
|
+
## Thanks
|
|
140
|
+
|
|
141
|
+
TAME exists because [Taskwarrior](https://taskwarrior.org) showed how good a command-line task
|
|
142
|
+
manager can be. Many thanks to its team and community for years of great work and for an open
|
|
143
|
+
JSON format that lets tools talk to each other.
|
|
144
|
+
|
|
145
|
+
TAME is an independent project: it shares no code, name or logo with Taskwarrior, and only aims
|
|
146
|
+
for compatibility with its JSON import/export format.
|
|
147
|
+
|
|
148
|
+
## Development
|
|
149
|
+
|
|
150
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
151
|
+
|
|
152
|
+
## License
|
|
153
|
+
|
|
154
|
+
[MIT](LICENSE)
|