2018-12-12 23:10:39 +00:00
|
|
|
# Potodo
|
2019-12-10 20:09:08 +00:00
|
|
|
Potodo, a (almost) flawless TODO/progress listing CLI tool for po files
|
2018-12-13 22:57:35 +00:00
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
```bash
|
|
|
|
pip install potodo
|
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
2018-12-14 09:29:40 +00:00
|
|
|
```
|
2019-03-13 10:09:05 +00:00
|
|
|
usage: potodo [-h] [-p PATH] [-l] [-f] [-o] [-n] [-a ABOVE] [-b BELOW]
|
2018-12-14 08:50:18 +00:00
|
|
|
|
|
|
|
List and prettify the po files left to translate
|
|
|
|
|
|
|
|
optional arguments:
|
|
|
|
-h, --help show this help message and exit
|
2018-12-14 16:13:30 +00:00
|
|
|
-p PATH, --path PATH Execute Potodo in the given path
|
2019-03-13 10:09:05 +00:00
|
|
|
-l, --matching-files Suppress normal output; instead print the name of each matching po file from which output would normally have been printed.
|
2018-12-14 08:50:18 +00:00
|
|
|
-f, --fuzzy Will only print files marked as fuzzys
|
2018-12-14 16:11:07 +00:00
|
|
|
-o, --offline Will not do any fetch to GitHub/online if given
|
|
|
|
-n, --no-reserved Will not print the info about reserved files
|
2018-12-14 08:50:18 +00:00
|
|
|
-a ABOVE, --above ABOVE
|
|
|
|
Will list all TODOs ABOVE given INT% completion
|
|
|
|
-b BELOW, --below BELOW
|
|
|
|
Will list all TODOs BELOW given INT% completion
|
2018-12-13 22:57:35 +00:00
|
|
|
```
|
2019-12-11 23:36:35 +00:00
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
You can run the tests using `tox` locally like:
|
|
|
|
|
|
|
|
tox -p auto
|
|
|
|
|
|
|
|
before commiting.
|
|
|
|
|
|
|
|
A pre-commit hook like:
|
|
|
|
```sh
|
|
|
|
cat <<EOF > .git/hooks/pre-commit
|
|
|
|
#!/bin/sh
|
|
|
|
exec tox -s -p all
|
|
|
|
EOF
|
|
|
|
```
|
|
|
|
may help.
|