simple-project-tracker 1.3.0__tar.gz → 1.4.1__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.
- {simple_project_tracker-1.3.0/simple_project_tracker.egg-info → simple_project_tracker-1.4.1}/PKG-INFO +34 -35
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/README.md +33 -34
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/pyproject.toml +3 -8
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1/simple_project_tracker.egg-info}/PKG-INFO +34 -35
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_cli.py +12 -32
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_commands.py +6 -6
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_daemon.py +5 -15
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_details.py +29 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_doctor.py +4 -10
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_frecency.py +3 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_identity.py +4 -12
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_keys.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_labels.py +2 -6
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_moves.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_paths.py +2 -6
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_portable.py +13 -19
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_relocate.py +13 -15
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_render.py +6 -18
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_selection.py +4 -13
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_settings.py +4 -13
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_storage.py +67 -12
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_todos.py +7 -13
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_tui.py +96 -5
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_undo.py +4 -2
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_view.py +5 -12
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/app.py +2 -6
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/commands.py +6 -23
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/doctor.py +6 -19
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/entries.py +8 -24
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/relocate.py +2 -4
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/todo.py +6 -33
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/defaults.py +6 -2
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/keys.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/paths.py +10 -4
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/settings.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/writer.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/daemon.py +10 -31
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/entries.py +16 -58
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/frecency.py +2 -7
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/identity.py +4 -16
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/inspect.py +40 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/labels.py +3 -9
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/portable.py +1 -3
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/selection.py +3 -11
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/storage.py +35 -9
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/todos.py +14 -7
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/undo.py +7 -11
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/view.py +1 -5
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/share/help.txt +7 -7
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/share/settings.toml +9 -2
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/details.py +17 -8
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/mentions.py +4 -20
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/render.py +9 -34
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/todos.py +5 -15
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/tui.py +490 -61
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/util/files.py +30 -16
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/util/text.py +4 -14
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/LICENSE +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/setup.cfg +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/simple_project_tracker.egg-info/SOURCES.txt +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/simple_project_tracker.egg-info/dependency_links.txt +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/simple_project_tracker.egg-info/entry_points.txt +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/simple_project_tracker.egg-info/top_level.txt +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_help.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tests/test_names.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/__main__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/cli/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/config/metadata.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/discovery.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/core/models.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/py.typed +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/share/completion.bash +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/share/completion.fish +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/share/completion.zsh +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/ansi.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/ask.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/ui/help.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/util/__init__.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/util/compat.py +0 -0
- {simple_project_tracker-1.3.0 → simple_project_tracker-1.4.1}/tracker/util/unknown.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: simple-project-tracker
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.4.1
|
|
4
4
|
Summary: Simple project tracker
|
|
5
5
|
Author-email: MattFor <mattfor@relaxy.xyz>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -30,14 +30,28 @@ Description-Content-Type: text/markdown
|
|
|
30
30
|
License-File: LICENSE
|
|
31
31
|
Dynamic: license-file
|
|
32
32
|
|
|
33
|
-
#
|
|
33
|
+
# Simple Project Tracker
|
|
34
34
|
|
|
35
|
-
[](https://github.com/MattFor/simple-project-tracker/actions/workflows/ci.yml)
|
|
36
|
+
[](https://pypi.org/project/simple-project-tracker/)
|
|
37
|
+
[](LICENSE)
|
|
37
38
|
|
|
38
|
-
A simple, but very
|
|
39
|
+
A simple, but very customisable tracker to keep track of your projects, their states and
|
|
39
40
|
your notes on them.
|
|
40
41
|
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
./install.sh # ~/.local
|
|
46
|
+
sudo ./install.sh # /usr/local
|
|
47
|
+
./install.sh --daemon # also install the daemon autostart entry
|
|
48
|
+
./install.sh --uninstall
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
52
|
+
|
|
53
|
+
## Usage
|
|
54
|
+
|
|
41
55
|
```
|
|
42
56
|
TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
43
57
|
--- | -- | ----------------------------- | ------- | ------------ | ---------------------
|
|
@@ -46,7 +60,7 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
46
60
|
3 | 26 | discord-profile-studio | stable | 1h ago
|
|
47
61
|
```
|
|
48
62
|
|
|
49
|
-
|
|
63
|
+
### Contents
|
|
50
64
|
|
|
51
65
|
- [Install](#install)
|
|
52
66
|
- [Commands](#commands)
|
|
@@ -54,28 +68,12 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
54
68
|
- [Selecting projects](#selecting-projects)
|
|
55
69
|
- [Several machines](#several-machines)
|
|
56
70
|
- [Configuration](#configuration)
|
|
57
|
-
- [
|
|
71
|
+
- [Contributing](#contributing)
|
|
58
72
|
- [License](#license)
|
|
59
73
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
```sh
|
|
63
|
-
./install.sh # ~/.local
|
|
64
|
-
sudo ./install.sh # /usr/local
|
|
65
|
-
./install.sh --daemon # also install the daemon autostart entry
|
|
66
|
-
./install.sh --uninstall
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
70
|
-
|
|
71
|
-
## Commands
|
|
74
|
+
### Commands
|
|
72
75
|
|
|
73
|
-
`t` on its own lists
|
|
74
|
-
monitored folders as a tree, each project's status and last change, and the `check` view of
|
|
75
|
-
the selected one beside it. Arrows move and fold, enter opens the details, `?` lists every
|
|
76
|
-
key: search, every project instead of the filtered ones, a flat list, the full tree, sorting,
|
|
77
|
-
one status at a time. Tab switches to your todos and the projects each one is about. `q`
|
|
78
|
-
quits. Piped, or with `t list`, it prints the table instead.
|
|
76
|
+
`t` on its own lists projects. With `output.browser` on it opens a browser.
|
|
79
77
|
|
|
80
78
|
| Command | Aliases | What it does |
|
|
81
79
|
| ------------ | ------------------- | -------------------------------------------------------------------- |
|
|
@@ -120,7 +118,7 @@ t all # everything with no limit and no filter
|
|
|
120
118
|
For more information do: `t help`, `t help <command>` or `t help <topic>`. The full guide
|
|
121
119
|
is within `man tracker`.
|
|
122
120
|
|
|
123
|
-
|
|
121
|
+
### Todos
|
|
124
122
|
|
|
125
123
|
List of notes that's separate from the main project database.
|
|
126
124
|
|
|
@@ -152,7 +150,7 @@ A note may point at a project with `@name`, printed as `name#id:tid` in that pro
|
|
|
152
150
|
status colour. `t check <project>` then lists the todos about it, and `t td check <todo>`
|
|
153
151
|
the projects it names.
|
|
154
152
|
|
|
155
|
-
|
|
153
|
+
### Selecting projects
|
|
156
154
|
|
|
157
155
|
| Selector | Means |
|
|
158
156
|
| ----------- | --------------------------------------------------------- |
|
|
@@ -169,12 +167,12 @@ A temporary ID is the index of the latest output.
|
|
|
169
167
|
When a partial name matches several projects, it's settled by
|
|
170
168
|
`projects.conflict_resolution_preference`.
|
|
171
169
|
|
|
172
|
-
|
|
170
|
+
### Several machines
|
|
173
171
|
|
|
174
172
|
The database can live in a Syncthing, Dropbox or git folder.
|
|
175
173
|
|
|
176
174
|
```sh
|
|
177
|
-
t mv db ~/
|
|
175
|
+
t mv db ~/syncthing/data.json # put the database where it syncs
|
|
178
176
|
t doctor # what is wrong with it
|
|
179
177
|
t fix # put that right, undoable
|
|
180
178
|
```
|
|
@@ -202,7 +200,7 @@ Tracked twice (2)
|
|
|
202
200
|
timestamp. Two different notes are joined rather than one being dropped, and `t undo`
|
|
203
201
|
takes the whole repair back.
|
|
204
202
|
|
|
205
|
-
|
|
203
|
+
### Configuration
|
|
206
204
|
|
|
207
205
|
```sh
|
|
208
206
|
t settings # everything (default deviations marked)
|
|
@@ -231,16 +229,18 @@ or by its initials, with the section shortening the same way: `display.list_limi
|
|
|
231
229
|
| `todos.sort`, `todos.newest_first` | How the todo list is ordered |
|
|
232
230
|
| `[todos.display]` | Display settings the todo list alone uses |
|
|
233
231
|
| `output.browser` | A bare `t` opens the project browser instead of the list |
|
|
232
|
+
| `output.branches` | `check` lists `local` branches, or `all` with remote ones |
|
|
234
233
|
|
|
235
234
|
Notes can colour themselves: `t note 12 {red}broken{/} since friday`.
|
|
236
235
|
|
|
237
|
-
##
|
|
236
|
+
## Contributing
|
|
238
237
|
|
|
239
238
|
```sh
|
|
240
|
-
|
|
241
|
-
make check # format, lint, types and tests (what CI runs)
|
|
239
|
+
pip install -e . ruff basedpyright pytest # editable install plus ruff, basedpyright, pytest
|
|
242
240
|
```
|
|
243
241
|
|
|
242
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) has the format, lint, type and test commands CI runs.
|
|
243
|
+
|
|
244
244
|
## Disclosure
|
|
245
245
|
|
|
246
246
|
LLMs were used to:
|
|
@@ -255,5 +255,4 @@ I wanted to get this project out asap as I really needed it :P
|
|
|
255
255
|
|
|
256
256
|
## License
|
|
257
257
|
|
|
258
|
-
MIT [LICENSE](LICENSE).
|
|
259
|
-
By MattFor.
|
|
258
|
+
MIT, see [LICENSE](LICENSE). By [MattFor](https://github.com/MattFor).
|
|
@@ -1,11 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Simple Project Tracker
|
|
2
2
|
|
|
3
|
-
[](https://github.com/MattFor/simple-project-tracker/actions/workflows/ci.yml)
|
|
4
|
+
[](https://pypi.org/project/simple-project-tracker/)
|
|
5
|
+
[](LICENSE)
|
|
5
6
|
|
|
6
|
-
A simple, but very
|
|
7
|
+
A simple, but very customisable tracker to keep track of your projects, their states and
|
|
7
8
|
your notes on them.
|
|
8
9
|
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
./install.sh # ~/.local
|
|
14
|
+
sudo ./install.sh # /usr/local
|
|
15
|
+
./install.sh --daemon # also install the daemon autostart entry
|
|
16
|
+
./install.sh --uninstall
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
9
23
|
```
|
|
10
24
|
TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
11
25
|
--- | -- | ----------------------------- | ------- | ------------ | ---------------------
|
|
@@ -14,7 +28,7 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
14
28
|
3 | 26 | discord-profile-studio | stable | 1h ago
|
|
15
29
|
```
|
|
16
30
|
|
|
17
|
-
|
|
31
|
+
### Contents
|
|
18
32
|
|
|
19
33
|
- [Install](#install)
|
|
20
34
|
- [Commands](#commands)
|
|
@@ -22,28 +36,12 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
22
36
|
- [Selecting projects](#selecting-projects)
|
|
23
37
|
- [Several machines](#several-machines)
|
|
24
38
|
- [Configuration](#configuration)
|
|
25
|
-
- [
|
|
39
|
+
- [Contributing](#contributing)
|
|
26
40
|
- [License](#license)
|
|
27
41
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
```sh
|
|
31
|
-
./install.sh # ~/.local
|
|
32
|
-
sudo ./install.sh # /usr/local
|
|
33
|
-
./install.sh --daemon # also install the daemon autostart entry
|
|
34
|
-
./install.sh --uninstall
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
38
|
-
|
|
39
|
-
## Commands
|
|
42
|
+
### Commands
|
|
40
43
|
|
|
41
|
-
`t` on its own lists
|
|
42
|
-
monitored folders as a tree, each project's status and last change, and the `check` view of
|
|
43
|
-
the selected one beside it. Arrows move and fold, enter opens the details, `?` lists every
|
|
44
|
-
key: search, every project instead of the filtered ones, a flat list, the full tree, sorting,
|
|
45
|
-
one status at a time. Tab switches to your todos and the projects each one is about. `q`
|
|
46
|
-
quits. Piped, or with `t list`, it prints the table instead.
|
|
44
|
+
`t` on its own lists projects. With `output.browser` on it opens a browser.
|
|
47
45
|
|
|
48
46
|
| Command | Aliases | What it does |
|
|
49
47
|
| ------------ | ------------------- | -------------------------------------------------------------------- |
|
|
@@ -88,7 +86,7 @@ t all # everything with no limit and no filter
|
|
|
88
86
|
For more information do: `t help`, `t help <command>` or `t help <topic>`. The full guide
|
|
89
87
|
is within `man tracker`.
|
|
90
88
|
|
|
91
|
-
|
|
89
|
+
### Todos
|
|
92
90
|
|
|
93
91
|
List of notes that's separate from the main project database.
|
|
94
92
|
|
|
@@ -120,7 +118,7 @@ A note may point at a project with `@name`, printed as `name#id:tid` in that pro
|
|
|
120
118
|
status colour. `t check <project>` then lists the todos about it, and `t td check <todo>`
|
|
121
119
|
the projects it names.
|
|
122
120
|
|
|
123
|
-
|
|
121
|
+
### Selecting projects
|
|
124
122
|
|
|
125
123
|
| Selector | Means |
|
|
126
124
|
| ----------- | --------------------------------------------------------- |
|
|
@@ -137,12 +135,12 @@ A temporary ID is the index of the latest output.
|
|
|
137
135
|
When a partial name matches several projects, it's settled by
|
|
138
136
|
`projects.conflict_resolution_preference`.
|
|
139
137
|
|
|
140
|
-
|
|
138
|
+
### Several machines
|
|
141
139
|
|
|
142
140
|
The database can live in a Syncthing, Dropbox or git folder.
|
|
143
141
|
|
|
144
142
|
```sh
|
|
145
|
-
t mv db ~/
|
|
143
|
+
t mv db ~/syncthing/data.json # put the database where it syncs
|
|
146
144
|
t doctor # what is wrong with it
|
|
147
145
|
t fix # put that right, undoable
|
|
148
146
|
```
|
|
@@ -170,7 +168,7 @@ Tracked twice (2)
|
|
|
170
168
|
timestamp. Two different notes are joined rather than one being dropped, and `t undo`
|
|
171
169
|
takes the whole repair back.
|
|
172
170
|
|
|
173
|
-
|
|
171
|
+
### Configuration
|
|
174
172
|
|
|
175
173
|
```sh
|
|
176
174
|
t settings # everything (default deviations marked)
|
|
@@ -199,16 +197,18 @@ or by its initials, with the section shortening the same way: `display.list_limi
|
|
|
199
197
|
| `todos.sort`, `todos.newest_first` | How the todo list is ordered |
|
|
200
198
|
| `[todos.display]` | Display settings the todo list alone uses |
|
|
201
199
|
| `output.browser` | A bare `t` opens the project browser instead of the list |
|
|
200
|
+
| `output.branches` | `check` lists `local` branches, or `all` with remote ones |
|
|
202
201
|
|
|
203
202
|
Notes can colour themselves: `t note 12 {red}broken{/} since friday`.
|
|
204
203
|
|
|
205
|
-
##
|
|
204
|
+
## Contributing
|
|
206
205
|
|
|
207
206
|
```sh
|
|
208
|
-
|
|
209
|
-
make check # format, lint, types and tests (what CI runs)
|
|
207
|
+
pip install -e . ruff basedpyright pytest # editable install plus ruff, basedpyright, pytest
|
|
210
208
|
```
|
|
211
209
|
|
|
210
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) has the format, lint, type and test commands CI runs.
|
|
211
|
+
|
|
212
212
|
## Disclosure
|
|
213
213
|
|
|
214
214
|
LLMs were used to:
|
|
@@ -223,5 +223,4 @@ I wanted to get this project out asap as I really needed it :P
|
|
|
223
223
|
|
|
224
224
|
## License
|
|
225
225
|
|
|
226
|
-
MIT [LICENSE](LICENSE).
|
|
227
|
-
By MattFor.
|
|
226
|
+
MIT, see [LICENSE](LICENSE). By [MattFor](https://github.com/MattFor).
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "simple-project-tracker"
|
|
7
|
-
version = "1.
|
|
7
|
+
version = "1.4.1"
|
|
8
8
|
description = "Simple project tracker"
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
requires-python = ">=3.11"
|
|
@@ -57,13 +57,11 @@ tracker = ["py.typed", "share/*.toml", "share/*.txt", "share/completion.*"]
|
|
|
57
57
|
dev = ["ruff", "basedpyright", "pytest>=9.0.2"]
|
|
58
58
|
|
|
59
59
|
[tool.ruff]
|
|
60
|
-
line-length =
|
|
61
|
-
indent-width = 4
|
|
60
|
+
line-length = 120
|
|
62
61
|
|
|
63
62
|
[tool.ruff.format]
|
|
64
63
|
indent-style = "tab"
|
|
65
|
-
quote-style = "
|
|
66
|
-
line-ending = "auto"
|
|
64
|
+
quote-style = "preserve"
|
|
67
65
|
skip-magic-trailing-comma = false
|
|
68
66
|
|
|
69
67
|
[tool.ruff.lint]
|
|
@@ -84,9 +82,6 @@ select = [
|
|
|
84
82
|
"RUF", # ruff specific
|
|
85
83
|
]
|
|
86
84
|
|
|
87
|
-
[tool.ruff.lint.pycodestyle]
|
|
88
|
-
max-line-length = 90
|
|
89
|
-
|
|
90
85
|
[tool.pytest.ini_options]
|
|
91
86
|
testpaths = ["tests"]
|
|
92
87
|
addopts = "--strict-markers --strict-config"
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: simple-project-tracker
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.4.1
|
|
4
4
|
Summary: Simple project tracker
|
|
5
5
|
Author-email: MattFor <mattfor@relaxy.xyz>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -30,14 +30,28 @@ Description-Content-Type: text/markdown
|
|
|
30
30
|
License-File: LICENSE
|
|
31
31
|
Dynamic: license-file
|
|
32
32
|
|
|
33
|
-
#
|
|
33
|
+
# Simple Project Tracker
|
|
34
34
|
|
|
35
|
-
[](https://github.com/MattFor/simple-project-tracker/actions/workflows/ci.yml)
|
|
36
|
+
[](https://pypi.org/project/simple-project-tracker/)
|
|
37
|
+
[](LICENSE)
|
|
37
38
|
|
|
38
|
-
A simple, but very
|
|
39
|
+
A simple, but very customisable tracker to keep track of your projects, their states and
|
|
39
40
|
your notes on them.
|
|
40
41
|
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
./install.sh # ~/.local
|
|
46
|
+
sudo ./install.sh # /usr/local
|
|
47
|
+
./install.sh --daemon # also install the daemon autostart entry
|
|
48
|
+
./install.sh --uninstall
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
52
|
+
|
|
53
|
+
## Usage
|
|
54
|
+
|
|
41
55
|
```
|
|
42
56
|
TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
43
57
|
--- | -- | ----------------------------- | ------- | ------------ | ---------------------
|
|
@@ -46,7 +60,7 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
46
60
|
3 | 26 | discord-profile-studio | stable | 1h ago
|
|
47
61
|
```
|
|
48
62
|
|
|
49
|
-
|
|
63
|
+
### Contents
|
|
50
64
|
|
|
51
65
|
- [Install](#install)
|
|
52
66
|
- [Commands](#commands)
|
|
@@ -54,28 +68,12 @@ TID | ID | NAME | STATUS | LAST TOUCHED | NOTE
|
|
|
54
68
|
- [Selecting projects](#selecting-projects)
|
|
55
69
|
- [Several machines](#several-machines)
|
|
56
70
|
- [Configuration](#configuration)
|
|
57
|
-
- [
|
|
71
|
+
- [Contributing](#contributing)
|
|
58
72
|
- [License](#license)
|
|
59
73
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
```sh
|
|
63
|
-
./install.sh # ~/.local
|
|
64
|
-
sudo ./install.sh # /usr/local
|
|
65
|
-
./install.sh --daemon # also install the daemon autostart entry
|
|
66
|
-
./install.sh --uninstall
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
Python 3.11+. Then `t init ~/(your project directory)` to fill the database.
|
|
70
|
-
|
|
71
|
-
## Commands
|
|
74
|
+
### Commands
|
|
72
75
|
|
|
73
|
-
`t` on its own lists
|
|
74
|
-
monitored folders as a tree, each project's status and last change, and the `check` view of
|
|
75
|
-
the selected one beside it. Arrows move and fold, enter opens the details, `?` lists every
|
|
76
|
-
key: search, every project instead of the filtered ones, a flat list, the full tree, sorting,
|
|
77
|
-
one status at a time. Tab switches to your todos and the projects each one is about. `q`
|
|
78
|
-
quits. Piped, or with `t list`, it prints the table instead.
|
|
76
|
+
`t` on its own lists projects. With `output.browser` on it opens a browser.
|
|
79
77
|
|
|
80
78
|
| Command | Aliases | What it does |
|
|
81
79
|
| ------------ | ------------------- | -------------------------------------------------------------------- |
|
|
@@ -120,7 +118,7 @@ t all # everything with no limit and no filter
|
|
|
120
118
|
For more information do: `t help`, `t help <command>` or `t help <topic>`. The full guide
|
|
121
119
|
is within `man tracker`.
|
|
122
120
|
|
|
123
|
-
|
|
121
|
+
### Todos
|
|
124
122
|
|
|
125
123
|
List of notes that's separate from the main project database.
|
|
126
124
|
|
|
@@ -152,7 +150,7 @@ A note may point at a project with `@name`, printed as `name#id:tid` in that pro
|
|
|
152
150
|
status colour. `t check <project>` then lists the todos about it, and `t td check <todo>`
|
|
153
151
|
the projects it names.
|
|
154
152
|
|
|
155
|
-
|
|
153
|
+
### Selecting projects
|
|
156
154
|
|
|
157
155
|
| Selector | Means |
|
|
158
156
|
| ----------- | --------------------------------------------------------- |
|
|
@@ -169,12 +167,12 @@ A temporary ID is the index of the latest output.
|
|
|
169
167
|
When a partial name matches several projects, it's settled by
|
|
170
168
|
`projects.conflict_resolution_preference`.
|
|
171
169
|
|
|
172
|
-
|
|
170
|
+
### Several machines
|
|
173
171
|
|
|
174
172
|
The database can live in a Syncthing, Dropbox or git folder.
|
|
175
173
|
|
|
176
174
|
```sh
|
|
177
|
-
t mv db ~/
|
|
175
|
+
t mv db ~/syncthing/data.json # put the database where it syncs
|
|
178
176
|
t doctor # what is wrong with it
|
|
179
177
|
t fix # put that right, undoable
|
|
180
178
|
```
|
|
@@ -202,7 +200,7 @@ Tracked twice (2)
|
|
|
202
200
|
timestamp. Two different notes are joined rather than one being dropped, and `t undo`
|
|
203
201
|
takes the whole repair back.
|
|
204
202
|
|
|
205
|
-
|
|
203
|
+
### Configuration
|
|
206
204
|
|
|
207
205
|
```sh
|
|
208
206
|
t settings # everything (default deviations marked)
|
|
@@ -231,16 +229,18 @@ or by its initials, with the section shortening the same way: `display.list_limi
|
|
|
231
229
|
| `todos.sort`, `todos.newest_first` | How the todo list is ordered |
|
|
232
230
|
| `[todos.display]` | Display settings the todo list alone uses |
|
|
233
231
|
| `output.browser` | A bare `t` opens the project browser instead of the list |
|
|
232
|
+
| `output.branches` | `check` lists `local` branches, or `all` with remote ones |
|
|
234
233
|
|
|
235
234
|
Notes can colour themselves: `t note 12 {red}broken{/} since friday`.
|
|
236
235
|
|
|
237
|
-
##
|
|
236
|
+
## Contributing
|
|
238
237
|
|
|
239
238
|
```sh
|
|
240
|
-
|
|
241
|
-
make check # format, lint, types and tests (what CI runs)
|
|
239
|
+
pip install -e . ruff basedpyright pytest # editable install plus ruff, basedpyright, pytest
|
|
242
240
|
```
|
|
243
241
|
|
|
242
|
+
[CONTRIBUTING.md](CONTRIBUTING.md) has the format, lint, type and test commands CI runs.
|
|
243
|
+
|
|
244
244
|
## Disclosure
|
|
245
245
|
|
|
246
246
|
LLMs were used to:
|
|
@@ -255,5 +255,4 @@ I wanted to get this project out asap as I really needed it :P
|
|
|
255
255
|
|
|
256
256
|
## License
|
|
257
257
|
|
|
258
|
-
MIT [LICENSE](LICENSE).
|
|
259
|
-
By MattFor.
|
|
258
|
+
MIT, see [LICENSE](LICENSE). By [MattFor](https://github.com/MattFor).
|
|
@@ -16,9 +16,7 @@ def test_free_text_commands_swallow_the_rest():
|
|
|
16
16
|
("add", ["~/code", "active", "a note with list in it"])
|
|
17
17
|
]
|
|
18
18
|
|
|
19
|
-
assert split(["edit", "3", "note", "check this remove that"]) == [
|
|
20
|
-
("edit", ["3", "note", "check this remove that"])
|
|
21
|
-
]
|
|
19
|
+
assert split(["edit", "3", "note", "check this remove that"]) == [("edit", ["3", "note", "check this remove that"])]
|
|
22
20
|
|
|
23
21
|
|
|
24
22
|
def test_dashed_aliases_are_accepted():
|
|
@@ -59,9 +57,7 @@ def test_flags_inside_a_note_stay_in_the_note():
|
|
|
59
57
|
def test_a_project_may_come_before_its_command():
|
|
60
58
|
assert split(["tracker", "check"]) == [("check", ["tracker"])]
|
|
61
59
|
assert split(["12", "path"]) == [("path", ["12"])]
|
|
62
|
-
assert split(["12", "edit", "status", "active"]) == [
|
|
63
|
-
("edit", ["12", "status", "active"])
|
|
64
|
-
]
|
|
60
|
+
assert split(["12", "edit", "status", "active"]) == [("edit", ["12", "status", "active"])]
|
|
65
61
|
|
|
66
62
|
|
|
67
63
|
def test_a_project_before_a_subjectless_command_stays_a_lookup():
|
|
@@ -70,9 +66,7 @@ def test_a_project_before_a_subjectless_command_stays_a_lookup():
|
|
|
70
66
|
|
|
71
67
|
def test_note_and_status_are_commands_of_their_own():
|
|
72
68
|
assert split(["note", "12", "review sunday"]) == [("note", ["12", "review sunday"])]
|
|
73
|
-
assert split(["12", "n", "review", "sunday"]) == [
|
|
74
|
-
("note", ["12", "review", "sunday"])
|
|
75
|
-
]
|
|
69
|
+
assert split(["12", "n", "review", "sunday"]) == [("note", ["12", "review", "sunday"])]
|
|
76
70
|
assert split(["12", "st", "blocked"]) == [("status", ["12", "blocked"])]
|
|
77
71
|
|
|
78
72
|
|
|
@@ -92,9 +86,7 @@ def test_flags_inside_a_bare_note_stay_in_the_note():
|
|
|
92
86
|
def test_sub_actions_are_not_mistaken_for_commands():
|
|
93
87
|
assert split(["settings", "path"]) == [("settings", ["path"])]
|
|
94
88
|
assert split(["settings", "edit"]) == [("settings", ["edit"])]
|
|
95
|
-
assert split(["settings", "set", "sorting.by", "name"]) == [
|
|
96
|
-
("settings", ["set", "sorting.by", "name"])
|
|
97
|
-
]
|
|
89
|
+
assert split(["settings", "set", "sorting.by", "name"]) == [("settings", ["set", "sorting.by", "name"])]
|
|
98
90
|
assert split(["daemon", "status"]) == [("daemon", ["status"])]
|
|
99
91
|
assert split(["daemon", "restart"]) == [("daemon", ["restart"])]
|
|
100
92
|
assert split(["daemon", "log", "40"]) == [("daemon", ["log", "40"])]
|
|
@@ -109,9 +101,7 @@ def test_a_double_dash_ends_the_options():
|
|
|
109
101
|
|
|
110
102
|
|
|
111
103
|
def test_a_double_dash_stops_command_matching():
|
|
112
|
-
assert split(["note", "3", "--", "check", "the", "list"]) == [
|
|
113
|
-
("note", ["3", "check", "the", "list"])
|
|
114
|
-
]
|
|
104
|
+
assert split(["note", "3", "--", "check", "the", "list"]) == [("note", ["3", "check", "the", "list"])]
|
|
115
105
|
|
|
116
106
|
assert split(["check", "--", "list"]) == [("check", ["list"])]
|
|
117
107
|
|
|
@@ -163,9 +153,7 @@ def test_a_greedy_command_still_answers_a_bare_help():
|
|
|
163
153
|
def test_help_inside_free_text_stays_free_text():
|
|
164
154
|
assert split(["note", "5", "help", "me"]) == [("note", ["5", "help", "me"])]
|
|
165
155
|
assert split(["note", "5", "--", "help"]) == [("note", ["5", "help"])]
|
|
166
|
-
assert split(["add", "~/code", "todo", "help"]) == [
|
|
167
|
-
("add", ["~/code", "todo", "help"])
|
|
168
|
-
]
|
|
156
|
+
assert split(["add", "~/code", "todo", "help"]) == [("add", ["~/code", "todo", "help"])]
|
|
169
157
|
|
|
170
158
|
|
|
171
159
|
def test_help_takes_a_topic_that_is_not_a_command():
|
|
@@ -180,9 +168,7 @@ def test_usage_is_only_recorded_when_it_is_turned_on():
|
|
|
180
168
|
for enabled in (True, False):
|
|
181
169
|
projects = make_projects(*SAMPLE)
|
|
182
170
|
|
|
183
|
-
context = Context(
|
|
184
|
-
settings=make_settings(projects__track_usage=enabled), data=projects
|
|
185
|
-
)
|
|
171
|
+
context = Context(settings=make_settings(projects__track_usage=enabled), data=projects)
|
|
186
172
|
|
|
187
173
|
assert context.mark_used(projects) is enabled
|
|
188
174
|
assert context.pending is enabled
|
|
@@ -208,7 +194,7 @@ def test_the_decorator_saves_what_a_command_used(tmp_path: Path):
|
|
|
208
194
|
from tests.helpers import SAMPLE, make_projects, make_settings
|
|
209
195
|
from tracker.cli.entries import Context, marks_used
|
|
210
196
|
|
|
211
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "data.
|
|
197
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "data.json")
|
|
212
198
|
|
|
213
199
|
projects = make_projects(*SAMPLE)
|
|
214
200
|
context = Context(settings=make_settings(), data=projects)
|
|
@@ -223,15 +209,13 @@ def test_the_decorator_saves_what_a_command_used(tmp_path: Path):
|
|
|
223
209
|
|
|
224
210
|
assert handler(context, []) == 0
|
|
225
211
|
assert context.pending is False
|
|
226
|
-
assert (tmp_path / "data.
|
|
212
|
+
assert (tmp_path / "data.json").is_file()
|
|
227
213
|
|
|
228
214
|
|
|
229
215
|
def test_editing_only_a_field_fuses_into_edit():
|
|
230
216
|
assert split(["11", "es", "shelf"]) == [("edit", ["11", "s", "shelf"])]
|
|
231
217
|
assert split(["t:11", "es", "stable"]) == [("edit", ["t:11", "s", "stable"])]
|
|
232
|
-
assert split(["11", "en", "review", "later"]) == [
|
|
233
|
-
("edit", ["11", "n", "review", "later"])
|
|
234
|
-
]
|
|
218
|
+
assert split(["11", "en", "review", "later"]) == [("edit", ["11", "n", "review", "later"])]
|
|
235
219
|
assert fuse("est") == ("edit", "st")
|
|
236
220
|
|
|
237
221
|
|
|
@@ -241,9 +225,7 @@ def test_a_fused_edit_keeps_its_free_text():
|
|
|
241
225
|
assert args == ["11", "en", "yes", "verbose"]
|
|
242
226
|
assert flags["verbose"] is False
|
|
243
227
|
|
|
244
|
-
assert split(["11", "en", "check", "the", "list"]) == [
|
|
245
|
-
("edit", ["11", "n", "check", "the", "list"])
|
|
246
|
-
]
|
|
228
|
+
assert split(["11", "en", "check", "the", "list"]) == [("edit", ["11", "n", "check", "the", "list"])]
|
|
247
229
|
|
|
248
230
|
|
|
249
231
|
def test_all_asks_a_listing_for_everything():
|
|
@@ -254,9 +236,7 @@ def test_all_asks_a_listing_for_everything():
|
|
|
254
236
|
|
|
255
237
|
def test_set_status_and_set_note_have_their_own_short_forms():
|
|
256
238
|
assert split(["12", "ss", "blocked"]) == [("status", ["12", "blocked"])]
|
|
257
|
-
assert split(["12", "sn", "review", "sunday"]) == [
|
|
258
|
-
("note", ["12", "review", "sunday"])
|
|
259
|
-
]
|
|
239
|
+
assert split(["12", "sn", "review", "sunday"]) == [("note", ["12", "review", "sunday"])]
|
|
260
240
|
assert split(["ss", "12", "blocked"]) == [("status", ["12", "blocked"])]
|
|
261
241
|
|
|
262
242
|
|
|
@@ -11,7 +11,7 @@ from tracker.cli.entries import Context
|
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
def context(tmp_path: Path, **overrides: object) -> Context:
|
|
14
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "data.
|
|
14
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "data.json")
|
|
15
15
|
|
|
16
16
|
return Context(settings=make_settings(**overrides), data=make_projects(*SAMPLE))
|
|
17
17
|
|
|
@@ -97,7 +97,7 @@ def test_all_lists_instead_of_describing_every_project(tmp_path: Path):
|
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
def test_an_unknown_command_is_reported(tmp_path: Path):
|
|
100
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "empty.
|
|
100
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "empty.json")
|
|
101
101
|
|
|
102
102
|
stream = io.StringIO()
|
|
103
103
|
|
|
@@ -109,7 +109,7 @@ def test_an_unknown_command_is_reported(tmp_path: Path):
|
|
|
109
109
|
|
|
110
110
|
|
|
111
111
|
def test_version_and_help_always_work(tmp_path: Path):
|
|
112
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "empty.
|
|
112
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "empty.json")
|
|
113
113
|
|
|
114
114
|
for arguments in (["version"], ["help"], ["help", "names"], ["--help"]):
|
|
115
115
|
stream = io.StringIO()
|
|
@@ -124,7 +124,7 @@ def test_version_and_help_always_work(tmp_path: Path):
|
|
|
124
124
|
def test_adding_a_moved_project_keeps_its_entry(tmp_path: Path):
|
|
125
125
|
from tracker.cli.commands import command_add, command_init
|
|
126
126
|
|
|
127
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "data.
|
|
127
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "data.json")
|
|
128
128
|
|
|
129
129
|
code = tmp_path / "code"
|
|
130
130
|
(code / "alpha" / ".git").mkdir(parents=True)
|
|
@@ -149,7 +149,7 @@ def test_adding_a_moved_project_keeps_its_entry(tmp_path: Path):
|
|
|
149
149
|
|
|
150
150
|
|
|
151
151
|
def status_sample(tmp_path: Path) -> Context:
|
|
152
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "data.
|
|
152
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "data.json")
|
|
153
153
|
|
|
154
154
|
return Context(
|
|
155
155
|
settings=make_settings(sorting__by="name", sorting__direction="ascending"),
|
|
@@ -280,7 +280,7 @@ def test_removing_a_project_leaves_the_other_numbers_alone(tmp_path: Path):
|
|
|
280
280
|
def test_a_scan_reports_what_it_actually_refreshed(tmp_path: Path):
|
|
281
281
|
from tracker.cli.commands import command_init
|
|
282
282
|
|
|
283
|
-
os.environ["TRACKER_DATA"] = str(tmp_path / "data.
|
|
283
|
+
os.environ["TRACKER_DATA"] = str(tmp_path / "data.json")
|
|
284
284
|
|
|
285
285
|
one = tmp_path / "one"
|
|
286
286
|
two = tmp_path / "two"
|