Metadata-Version: 2.4
Name: whatnext
Version: 0.4
Summary: A lister of tasks found in Markdown files
Project-URL: Homepage, https://github.com/norm/whatnext
Project-URL: Repository, https://github.com/norm/whatnext
Project-URL: Documentation, https://github.com/norm/whatnext
Author: Mark Norman Francis
License-Expression: MIT
License-File: LICENCE
License-File: LICENSE
Keywords: cli,markdown,tasks,todo
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Requires-Dist: toml
Provides-Extra: test
Requires-Dist: flake8; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# What next?

Document your tasks in Markdown files, using an expanded version of the
original [GitHub task list notation][sn]:

```markdown
- [ ] open, this task is outstanding
- [/] in progress, this task is partially complete
- [X] complete, this task has been finished
- [#] cancelled, this task has been scratched
- [<] blocked, this task needs more input

- [ ] _a little more important_
- [ ] **a lot more important**
```

Then install `whatnext`:

```bash
pip install whatnext
```

Now run it and it'll tell you what's next, sorting by priority and state:

```bash
(computer)% whatnext
README.md:
    # What next?
    - [ ] a lot more important

README.md:
    # What next?
    - [ ] a little more important

README.md:
    # What next?
    - [/] in progress, this task is partially complete
    - [ ] open, this task is outstanding
    - [<] blocked, this task needs more input
```

More detail to be found:

- [The basics of task formatting](https://github.com/norm/whatnext/blob/main/docs/basics.md)
- [Prioritisation](https://github.com/norm/whatnext/blob/main/docs/prioritisation.md)
- [whatnext usage and arguments](https://github.com/norm/whatnext/blob/main/docs/usage.md)
- [The `.whatnext` file](https://github.com/norm/whatnext/blob/main/docs/dotwhatnext.md)


## The reason

I like to keep tasks in Markdown files. That way they can be interspersed
within instructions, serving as reminders, FIXMEs, and other todos.


[sn]: https://blog.github.com/2013-01-09-task-lists-in-gfm-issues-pulls-comments/
