potodo/README.md

Potodo

Potodo, a (almost) flawless TODO/progress listing CLI tool for po files.

Installation

pip install potodo

Usage

usage: potodo [-h] [-p path] [-e path [path ...]] [-a X] [-b X] [-f] [-o] [-n] [-c] [-j] [--exclude-fuzzy] [--exclude-reserved] [--only-reserved] [--show-reservation-dates] [--version]

List and prettify the po files left to translate.

optional arguments:
  -h, --help            show this help message and exit
  -p path, --path path  execute Potodo in path
  -e path [path ...], --exclude path [path ...]
                        exclude from search
  -a X, --above X       list all TODOs above given X% completion
  -b X, --below X       list all TODOs below given X% completion
  -f, --only-fuzzy      print only files marked as fuzzys
  -o, --offline         don't perform any fetching to GitHub/online
  -n, --no-reserved     don't print info about reserved files
  -c, --counts          render list with the count of remaining entries (translate or review) rather than percentage done
  -j, --json            format output as JSON
  --exclude-fuzzy       select only files without fuzzy entries
  --exclude-reserved    select only files that aren't reserved
  --only-reserved       select only only reserved files
  --show-reservation-dates
                        show issue creation dates
  --version             show program's version number and exit

Contributing

You can run the tests using tox locally like:

tox -p auto

before commiting.

A pre-commit hook like:

cat <<EOF > .git/hooks/pre-commit
#!/bin/sh
exec tox -s -p all
EOF

may help.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Julien Palard 👀 💻

Antoine 👀 💻

This project follows the all-contributors specification. Contributions of any kind welcome!