2018-12-12 23:10:39 +00:00
# Potodo
2020-10-13 15:09:39 +00:00
[![Build Status ](https://travis-ci.com/Seluj78/Potodo.svg?branch=master )](https://travis-ci.com/Seluj78/Potodo)
2020-08-17 16:08:50 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:START - Do not remove or modify this section -->
2020-10-13 11:33:30 +00:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square )](#contributors-)
2020-08-17 16:08:50 +00:00
<!-- ALL - CONTRIBUTORS - BADGE:END -->
2020-01-13 22:12:15 +00:00
Potodo, a (almost) flawless TODO/progress listing CLI tool for po files.
2018-12-13 22:57:35 +00:00
2020-10-14 11:36:12 +00:00
### Potodo is part of poutils!
2020-10-14 11:33:01 +00:00
2020-10-14 11:36:41 +00:00
[Poutils ](https://pypi.org/project/poutils ) (`.po` utils) is is a metapackage to easily install usefull Python tools to use with po files
2020-10-14 11:43:05 +00:00
and `potodo` is a part of it! Go check out [Poutils ](https://pypi.org/project/poutils ) to discover the other useful tools for `po` file related translation!
2020-10-14 11:33:01 +00:00
2018-12-13 22:57:35 +00:00
## Installation
```bash
pip install potodo
```
## Usage
2018-12-14 09:29:40 +00:00
```
2020-10-14 19:25:29 +00:00
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] [--no-cache] [-i] [-l] [--version] [-v]
2018-12-14 08:50:18 +00:00
2020-01-14 21:06:45 +00:00
List and prettify the po files left to translate.
2018-12-14 08:50:18 +00:00
optional arguments:
-h, --help show this help message and exit
2020-06-03 12:02:03 +00:00
-p path, --path path execute Potodo in path
-e path [path ...], --exclude path [path ...]
exclude from search
2020-01-13 22:12:15 +00:00
-a X, --above X list all TODOs above given X% completion
-b X, --below X list all TODOs below given X% completion
2020-09-15 08:58:49 +00:00
-f, --only-fuzzy print only files marked as fuzzys
2020-01-13 22:12:15 +00:00
-o, --offline don't perform any fetching to GitHub/online
-n, --no-reserved don't print info about reserved files
2020-09-15 08:49:50 +00:00
-c, --counts render list with the count of remaining entries (translate or review) rather than percentage done
2020-09-15 11:59:43 +00:00
-j, --json format output as JSON
--exclude-fuzzy select only files without fuzzy entries
2020-09-15 09:05:47 +00:00
--exclude-reserved select only files that aren't reserved
2020-09-15 12:04:35 +00:00
--only-reserved select only only reserved files
2020-09-15 09:32:15 +00:00
--show-reservation-dates
2020-09-15 12:04:35 +00:00
show issue creation dates
2020-10-13 11:21:57 +00:00
--no-cache Disables cache (Cache is disabled when files are modified)
-i, --interactive Activates the interactive menu
2020-10-14 19:25:29 +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.
2020-01-13 22:12:15 +00:00
--version show program's version number and exit
2020-10-13 11:21:57 +00:00
-v, --verbose Increases output verbosity
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
```
2020-01-13 22:12:15 +00:00
may help.
2020-08-17 16:08:50 +00:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
< table >
< tr >
< td align = "center" > < a href = "https://mdk.fr" > < img src = "https://avatars2.githubusercontent.com/u/239510?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Julien Palard< / b > < / sub > < / a > < br / > < a href = "https://github.com/Seluj78/Potodo/pulls?q=is%3Apr+reviewed-by%3AJulienPalard" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/Seluj78/Potodo/commits?author=JulienPalard" title = "Code" > 💻< / a > < / td >
2020-08-17 16:11:17 +00:00
< td align = "center" > < a href = "https://github.com/awecx" > < img src = "https://avatars1.githubusercontent.com/u/43954001?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Antoine< / b > < / sub > < / a > < br / > < a href = "https://github.com/Seluj78/Potodo/pulls?q=is%3Apr+reviewed-by%3Aawecx" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/Seluj78/Potodo/commits?author=awecx" title = "Code" > 💻< / a > < / td >
2020-10-13 11:27:05 +00:00
< td align = "center" > < a href = "https://juleslasne.com" > < img src = "https://avatars0.githubusercontent.com/u/4641317?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Jules Lasne (jlasne)< / b > < / sub > < / a > < br / > < a href = "https://github.com/Seluj78/Potodo/pulls?q=is%3Apr+reviewed-by%3ASeluj78" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/Seluj78/Potodo/commits?author=Seluj78" title = "Code" > 💻< / a > < / td >
2020-10-13 11:29:14 +00:00
< td align = "center" > < a href = "https://github.com/christopheNan" > < img src = "https://avatars2.githubusercontent.com/u/35002064?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Christophe Nanteuil< / b > < / sub > < / a > < br / > < a href = "https://github.com/Seluj78/Potodo/pulls?q=is%3Apr+reviewed-by%3AchristopheNan" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/Seluj78/Potodo/commits?author=christopheNan" title = "Code" > 💻< / a > < / td >
2020-10-13 11:29:25 +00:00
< td align = "center" > < a href = "https://github.com/grenoya" > < img src = "https://avatars3.githubusercontent.com/u/996321?v=4" width = "100px;" alt = "" / > < br / > < sub > < b > Claire Revillet< / b > < / sub > < / a > < br / > < a href = "https://github.com/Seluj78/Potodo/pulls?q=is%3Apr+reviewed-by%3Agrenoya" title = "Reviewed Pull Requests" > 👀< / a > < a href = "https://github.com/Seluj78/Potodo/commits?author=grenoya" title = "Code" > 💻< / a > < / td >
2020-08-17 16:08:50 +00:00
< / tr >
< / table >
<!-- markdownlint - enable -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2020-09-15 11:05:30 +00:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!