worklogs 0.2.0__tar.gz → 0.3.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.
- {worklogs-0.2.0 → worklogs-0.3.0}/PKG-INFO +47 -5
- {worklogs-0.2.0 → worklogs-0.3.0}/README.md +46 -4
- {worklogs-0.2.0 → worklogs-0.3.0}/docs/api.md +6 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/pyproject.toml +5 -1
- {worklogs-0.2.0 → worklogs-0.3.0}/src/worklogs/__init__.py +1 -1
- worklogs-0.3.0/src/worklogs/cli.py +730 -0
- worklogs-0.3.0/tests/test_package.py +317 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/uv.lock +1 -1
- worklogs-0.2.0/src/worklogs/cli.py +0 -610
- worklogs-0.2.0/tests/test_package.py +0 -271
- {worklogs-0.2.0 → worklogs-0.3.0}/.github/PULL_REQUEST_TEMPLATE.md +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/.github/workflows/ci.yml +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/.github/workflows/release.yml +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/.gitignore +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/.pre-commit-config.yaml +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/.python-version +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/AGENTS.md +0 -0
- {worklogs-0.2.0 → worklogs-0.3.0}/src/worklogs/py.typed +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: worklogs
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.3.0
|
|
4
4
|
Summary: Local markdown worklog helpers for developer workflows.
|
|
5
5
|
Project-URL: Homepage, https://github.com/alik-git/worklogs
|
|
6
6
|
Project-URL: Repository, https://github.com/alik-git/worklogs
|
|
@@ -99,6 +99,41 @@ Print created paths for scripts:
|
|
|
99
99
|
worklogs new note--personal-site--theme-ideas --scope personal --print-path
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
+
Create a dated project workset directory:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
worklogs workset new backend-api-refactor --worksets-root ~/worksets
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Create a dated workset under organizer folders:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
worklogs workset new release-tools/python-packaging/worklogs-0.2.1 \
|
|
112
|
+
--worksets-root ~/worksets
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Worksets are created under:
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
<worksets-root>/YYYY/MM/DD/<workset-path>/
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Preview a workset path without creating it:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
worklogs workset new release-tools/python-packaging/worklogs-0.2.1 \
|
|
125
|
+
--worksets-root ~/worksets \
|
|
126
|
+
--dry-run
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Print only the created path for scripts:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
worklogs workset new backend-api-refactor \
|
|
133
|
+
--worksets-root ~/worksets \
|
|
134
|
+
--print-path
|
|
135
|
+
```
|
|
136
|
+
|
|
102
137
|
Supported kinds:
|
|
103
138
|
|
|
104
139
|
```text
|
|
@@ -122,13 +157,14 @@ Example:
|
|
|
122
157
|
root = "~/worklog"
|
|
123
158
|
default_scope = "work"
|
|
124
159
|
timezone = "America/Toronto"
|
|
160
|
+
worksets_root = "~/worksets"
|
|
125
161
|
```
|
|
126
162
|
|
|
127
163
|
Resolution order:
|
|
128
164
|
|
|
129
165
|
1. CLI flags
|
|
130
166
|
2. environment variables: `WORKLOG_ROOT`, `WORKLOG_SCOPE`,
|
|
131
|
-
`WORKLOG_TIMEZONE`
|
|
167
|
+
`WORKLOG_TIMEZONE`, `WORKLOG_WORKSETS_ROOT`
|
|
132
168
|
3. config file
|
|
133
169
|
4. package defaults
|
|
134
170
|
|
|
@@ -138,6 +174,12 @@ With `default_scope` configured, the fast path can omit `--scope`:
|
|
|
138
174
|
worklogs new plan--backend-api--improve-deploy-notes
|
|
139
175
|
```
|
|
140
176
|
|
|
177
|
+
With `worksets_root` configured, the workset path can omit `--worksets-root`:
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
worklogs workset new backend-api-refactor
|
|
181
|
+
```
|
|
182
|
+
|
|
141
183
|
For shorter personal shell usage, add a local alias:
|
|
142
184
|
|
|
143
185
|
```bash
|
|
@@ -196,9 +238,9 @@ Environment name: pypi
|
|
|
196
238
|
Create a GitHub Release for the version in [`pyproject.toml`](pyproject.toml):
|
|
197
239
|
|
|
198
240
|
```bash
|
|
199
|
-
gh release create v0.2.
|
|
200
|
-
--title "v0.2.
|
|
201
|
-
--notes "Add
|
|
241
|
+
gh release create v0.2.1 \
|
|
242
|
+
--title "v0.2.1" \
|
|
243
|
+
--notes "Add dated workset directory creation."
|
|
202
244
|
```
|
|
203
245
|
|
|
204
246
|
Publishing is release-driven on purpose: normal pushes and pull requests build
|
|
@@ -72,6 +72,41 @@ Print created paths for scripts:
|
|
|
72
72
|
worklogs new note--personal-site--theme-ideas --scope personal --print-path
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
+
Create a dated project workset directory:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
worklogs workset new backend-api-refactor --worksets-root ~/worksets
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Create a dated workset under organizer folders:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
worklogs workset new release-tools/python-packaging/worklogs-0.2.1 \
|
|
85
|
+
--worksets-root ~/worksets
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Worksets are created under:
|
|
89
|
+
|
|
90
|
+
```text
|
|
91
|
+
<worksets-root>/YYYY/MM/DD/<workset-path>/
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Preview a workset path without creating it:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
worklogs workset new release-tools/python-packaging/worklogs-0.2.1 \
|
|
98
|
+
--worksets-root ~/worksets \
|
|
99
|
+
--dry-run
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Print only the created path for scripts:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
worklogs workset new backend-api-refactor \
|
|
106
|
+
--worksets-root ~/worksets \
|
|
107
|
+
--print-path
|
|
108
|
+
```
|
|
109
|
+
|
|
75
110
|
Supported kinds:
|
|
76
111
|
|
|
77
112
|
```text
|
|
@@ -95,13 +130,14 @@ Example:
|
|
|
95
130
|
root = "~/worklog"
|
|
96
131
|
default_scope = "work"
|
|
97
132
|
timezone = "America/Toronto"
|
|
133
|
+
worksets_root = "~/worksets"
|
|
98
134
|
```
|
|
99
135
|
|
|
100
136
|
Resolution order:
|
|
101
137
|
|
|
102
138
|
1. CLI flags
|
|
103
139
|
2. environment variables: `WORKLOG_ROOT`, `WORKLOG_SCOPE`,
|
|
104
|
-
`WORKLOG_TIMEZONE`
|
|
140
|
+
`WORKLOG_TIMEZONE`, `WORKLOG_WORKSETS_ROOT`
|
|
105
141
|
3. config file
|
|
106
142
|
4. package defaults
|
|
107
143
|
|
|
@@ -111,6 +147,12 @@ With `default_scope` configured, the fast path can omit `--scope`:
|
|
|
111
147
|
worklogs new plan--backend-api--improve-deploy-notes
|
|
112
148
|
```
|
|
113
149
|
|
|
150
|
+
With `worksets_root` configured, the workset path can omit `--worksets-root`:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
worklogs workset new backend-api-refactor
|
|
154
|
+
```
|
|
155
|
+
|
|
114
156
|
For shorter personal shell usage, add a local alias:
|
|
115
157
|
|
|
116
158
|
```bash
|
|
@@ -169,9 +211,9 @@ Environment name: pypi
|
|
|
169
211
|
Create a GitHub Release for the version in [`pyproject.toml`](pyproject.toml):
|
|
170
212
|
|
|
171
213
|
```bash
|
|
172
|
-
gh release create v0.2.
|
|
173
|
-
--title "v0.2.
|
|
174
|
-
--notes "Add
|
|
214
|
+
gh release create v0.2.1 \
|
|
215
|
+
--title "v0.2.1" \
|
|
216
|
+
--notes "Add dated workset directory creation."
|
|
175
217
|
```
|
|
176
218
|
|
|
177
219
|
Publishing is release-driven on purpose: normal pushes and pull requests build
|
|
@@ -9,5 +9,11 @@ Use `worklogs new` to create dated markdown worklog files:
|
|
|
9
9
|
worklogs new plan--backend-api--improve-deploy-notes --scope work
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
+
Use `worklogs workset new` to create dated project workset directories:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
worklogs workset new backend-api-refactor --worksets-root ~/worksets
|
|
16
|
+
```
|
|
17
|
+
|
|
12
18
|
Public Python helpers will be documented here if the package grows a stable API
|
|
13
19
|
outside the CLI.
|
|
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "worklogs"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "0.3.0"
|
|
8
8
|
description = "Local markdown worklog helpers for developer workflows."
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
requires-python = ">=3.11"
|
|
@@ -146,3 +146,7 @@ disable_error_code = ["import-untyped"]
|
|
|
146
146
|
# Make local and CI output easier to read and easier to suppress precisely.
|
|
147
147
|
show_error_codes = true
|
|
148
148
|
pretty = true
|
|
149
|
+
|
|
150
|
+
[[tool.mypy.overrides]]
|
|
151
|
+
module = "workset.*"
|
|
152
|
+
ignore_missing_imports = true
|