Repository navigation
Expand file tree
/
Copy pathCHANGELOG.rst
More file actions
334 lines (255 loc) · 9.84 KB
/
Copy pathCHANGELOG.rst
File metadata and controls
334 lines (255 loc) · 9.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
Changelog
=========
This file contains a brief summary of new features and dependency changes or
releases, in reverse chronological order.
v4.7.0
------
* Removed ``bin/todo``. It is no longer requierd, as the entry point generated
by setuptools no longer has performance issues.
v4.6.0
------
* **BREAKING**: Dropped support for Python 3.8.
* The default value for ``path`` is now ``~/calendars/*``. Previously this
value was required. This change is non-breaking; all existing valid
configurations define this value.
* Drop dependency on ``atomicwrites`` which is now unmaintained.
* Implement ``--read-description`` for the ``edit`` command.
* ``setuptools>=77`` is now required at build time.
v4.5.0
------
* The ``PRODID`` for new entries has changed ``io.barrera.todoman`` to
``nl.whynothugo.todoman``. This has no functional impact, but may be relevant
when debugging the origin of specific files.
* Drop ``sphinx-autorun`` dependency for the docs as it has been unused for some
time now anyway.
* Add a new ``path`` command which prints the full file path to a task.
* Show a clearer error when ``click-repl`` is missing.
* Drop usage of ``pytz``. This was previously a transitive dependency via
``icalendar``.
v4.4.0
------
* Add support for Python 3.12. Todoman already worked with Python 3.12, but is
now tested with this Python version in CI and has the relevant classifiers.
* Fix crash when trying to use Python 3.9.
v4.3.2
------
* Fix filtering for non-ASCII categories.
v4.3.1
------
* Identical to v4.3.0, which was not properly published to PyPI.
v4.3.0
------
* Add support for Python 3.11. Todoman already worked with Python 3.11, but is
now tested with this Python version in CI and has the relevant classifiers.
* Improved zsh shell completion.
* Dropped ``setup.py`` in favour of ``pyproject.toml``.
v4.2.0
------
* Added full support for categories.
v4.1.0
------
* The "table" layout has been dropped in favour of a simpler, fluid layout. As
such, ``tabulate`` is not longer a required dependency.
* Added support for python 3.10.
v4.0.1
------
* Fix issue passing arguments to ``default_command``.
* Various documentation improvements.
v4.0.0
------
Breaking changes in the configuration format
********************************************
The configuration format is changing with release 4.0.0. We currently depend on
an unmaintained library for configuration. It's not currently in a working
state, and while some distributions are patching it, setting up a clean
environment is a bit non-trivial, and the situation will only degrade in future.
The changes in format are be subtle, and also come with an intention to add
further extensibility in future. Configuration files will be plain python. If
you don't know Python don't worry, you don't _need_ to know Python.
I'll take my own config as a reference. The pre-4.0.0 format is:
```dosini
[main]
path = ~/.local/share/calendars/*
time_format = '%H:%M'
default_list = todo
humanize = true
startable = true
```
The 4.0.0 version would look like this:
```python
path = "~/.local/share/calendars/*"
time_format = "%H:%M"
default_list = "todo"
humanize = True
startable = True
```
Key differences:
- The `[main]` header is no longer needed.
- All strings must be quoted (this was previously optional).
- True and False start with uppercase.
- Using `yes` or `on` is no longer valid; only `True` and `False` are valid.
That's basically it. This lets up drop the problematic dependency, and we don't
actually need anything to read the config: it's just python code like the rest
of `todoman`!
For those users who _are_ python developers, you'll note this gives some
interesting flexibility: you CAN add any custom python code into the config
file. For example, you can defined the `path` programatically:
.. code-block:: python
def get_path() -> str:
...
path = get_path
Dropped support
***************
* Dropped support older Python versions. Only 3.8 and 3.9 are now supported.
Minor changes
*************
* Added support for python 3.9.
* The dependency `configobj` is no longer required.
* Click 8.0 is now supported.
* Fix crash when ``default_command`` has arguments.
v3.9.0
------
* The man page has been improved. ``sphinx-click`` is now required to build the
documentation.
v3.8.0
------
* Don't display list if there's only one list (of one list has been specified).
* Fixed several issues when using dates with no times.
* Dropped support for Python 3.4.
v3.7.0
------
* Properly support iCal files with dates (instead of datetimes).
v3.6.0
------
* Allow passing a custom configuration file with the ``--config/-c`` option.
* Cached list metadata is now invalidated when it has changed on-disk.
* Support for click < 6.0 has been dropped (it wasn't actually working
perfectly any more anyway). Click 7.x is the only currently supported
version.
* ``click-repl`` is now listed as an optional dependency. It is required for
the ``todo repl`` command.
* Add the ``default_priority`` config setting.
* Drop support for Python 3.4.
v3.5.0
------
* Fix crashes due to API changes in icalendar 4.0.3.
* Dropped compatibility for icalendar < 4.0.3.
v3.4.1
------
* Support Python 3.7.
* Support click>=7.0.
* Properly parse RBGA colours.
v3.4.0
------
* Add ``-r`` option to ``new`` to read description from ``stdin``.
* Add a dedicated zsh completion function.
* Lists matching is now case insensitive, unless there are multiple lists with
colliding names, in which case those will be treated case-sensitive.
* Fix some tests that failed due to test dependency changes.
v3.3.0
------
* New runtime dependency: ``click-log``.
* Drop support for Python 3.3, which has reached its end of life cycle.
* Add `--raw` flag to `edit`. This allows editing the raw icalendar file, but
**only use this if you really know what you're doing**. There's a big risk of
data loss, and this is considered a developer / expert feature!
v3.2.4
------
* Deploy new versions to PyPI using ``twine``. Travis doesn't seem to be
working.
v3.2.3
------
* Tests should no longer fail with ``pyicu`` installed.
* Improved documentation regarding how to test locally.
v3.2.2
------
* Initial support for (bash) autocompletion.
* The location field is not printed as part of ``--porcelain``.
v3.2.1
------
* Fix start-up crash caused by click_log interface change.
* Dropped runtime dependency: ``click_log``.
v3.2.0
------
* Completing recurring todos now works as expected and does not make if
disappear forever.
v3.1.0
------
* Last-modified fields of todos are now updated upon edition.
* Sequence numbers are now properly increased upon edition.
* Add new command ``todo cancel`` to cancel an existing todo without deleting
it.
* Add a new setting ``default_command``.
* Replace ``--all`` and ``--done-only`` with ``--status``, which allows
fine-grained status filtering. Use ``--status ANY`` or ``--status COMPLETED``
to obtain the same results as the previous flags.
* Rename ``--today`` flag to ``--startable``.
* Illegal start dates (eg: start dates that are not before the due date) are
ignored and are removed when saving an edited todo.
v3.0.1
------
* Fix a crash for users upgrading from pre-v3.0.0, caused due to the cache's
schema not being updated.
v3.0.0
------
New features
************
* Add a ``today`` setting and flag to exclude todos that start in the future.
* Add the ``--humanize`` to show friendlier date times (eg: ``in 3 hours``).
* Drop ``--urgent`` and introduced ``--priority``, which allows fine-filtering
by priority.
* Add support for times in due dates, new ``time_format`` setting.
* Use the system's date format as a default.
* Add list selector to the interactive editor.
* Add ``--start=[before|after] [DATE]`` option for ``list`` to only show
todos starting before/after given date.
* Add flag "--done-only" to todo list. Displays only completed tasks.
* Make the output of move, delete, copy and flush consistent.
* Porcelain now outputs proper JSON, rather than one-JSON-per-line.
* Increment sequence number upon edits.
* Print a descriptive message when no lists are found.
* Add full support for locations.
Packaging changes
*****************
* New runtime dependency: ``tabulate``.
* New runtime dependency: ``humanize``.
* New supported python version: ``pypy3``.
* Include an alternative [much faster] entry point (aka "bin") which we
recommend all downstream packagers use. Please see the :ref:`Notes for
Packagers <notes-for-packagers>` documentation for further details.
v2.1.0
------
* The global ``--verbosity`` option has been introduced. It doesn't do much for
now though, because we do not have many debug logging statements.
* New PyPI dependency ``click-log``.
* The ``--no-human-time`` flag is gone. Integrations/scripts might want to look
at ``--porcelain`` as an alternative.
* Fix crash when running ``todo new``.
* Fixes some issues when filtering todos from different timezones.
* Attempt to create the cache file's directory if it does not exist.
* Fix crash when running ``--porcelain show``.
* Show ``id`` for todos everywhere (eg: including new, etc).
* Add the ``ctrl-s`` shortcut for saving in the interactive editor.
v2.0.2
------
* Fix a crash after editing or completing a todo.
v2.0.1
------
* Fix a packaging error.
v2.0.0
------
New features
~~~~~~~~~~~~
* New flag ``--porcelain`` for programmatic integrations to use. See the
``integrations`` section :doc:`here </usage>` for details.
* Implement a new :doc:`configuration option </configure>`: ``default_due``.
* The configuration file is now pre-emptively validated. Users will be warned
of any inconsistencies.
* The ``list`` command has a new ``--due`` flag to filter tasks due soon.
* Todo ids are now persisted in a cache. They can be manually purged using
``flush``.
Packaging changes
~~~~~~~~~~~~~~~~~
* New runtime dependency: configobj
* New runtime dependency: python-dateutil
* New test dependency: flake8-import-order.