| Name | potodo JSON |
| Version |
0.21.3
JSON |
| download |
| home_page | |
| Summary | List .po files to be translated. |
| upload_time | 2023-03-25 13:31:57 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License |
| keywords |
potodo
gettext
i18n
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img width=60% src="https://git.afpy.org/AFPy/potodo/raw/branch/main/media/Potodo.png">
</p>
<p align="center">
<img src="https://img.shields.io/pypi/v/potodo">
<img src="https://img.shields.io/badge/python-v3.6+-blue.svg">
<img src="https://img.shields.io/badge/license-MIT-blue.svg">
<img src="https://img.shields.io/badge/contributions-welcome-orange.svg">
</p>
## What is it ?
Potodo, a (almost) flawless TODO/progress listing CLI tool for po files.
### Potodo is part of poutils!
[Poutils](https://pypi.org/project/poutils) (`.po` utils) is is a metapackage to easily install usefull Python tools to use with po files
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!
## Installation
```sh
pip install potodo
```
## Usage example
```
usage: potodo [-h] [-p path] [-e path [path ...]] [-a X] [-b X] [-f] [-u API_URL] [-n] [-c] [-j] [--exclude-fuzzy] [--exclude-reserved]
[--only-reserved] [--show-reservation-dates] [--no-cache] [-i] [-l] [--version] [-v]
List and prettify the po files left to translate.
options:
-h, --help show this help message and exit
-p path, --path path execute Potodo in path
-e path [path ...], --exclude path [path ...]
gitignore-style patterns to 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
-u API_URL, --api-url API_URL
API URL to retrieve reservation tickets (https://api.github.com/repos/ORGANISATION/REPOSITORY/issues?state=open or
https://git.afpy.org/api/v1/repos/ORGANISATION/REPOSITORY/issues?state=open&type=issues)
-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
--no-cache Disables cache (Cache is disabled when files are modified)
-i, --interactive Activates the interactive menu
-l, --matching-files Suppress normal output; instead print the name of each matching po file from which output would normally have been
printed.
--version show program's version number and exit
-v, --verbose Increases output verbosity
```
## Development setup
Create a virtual environment
```sh
python3 -m venv venv
```
Activate it
```sh
source venv/bin/activate
```
Install the dev requirements
```sh
pip install -r requirements-dev.txt
```
Install the pre-commit hook
```sh
pre-commit install
```
Install `potodo` in a development version
```
pip install -e .
```
## Release History
* v0.21.2
* FIX: Don't miss issues (reservations) to files containing multiple dots. Contributed by @eviau.
* v0.21.0
* A nice new README
* v0.20.0
* New exclude behavior with gitignore style matching !
* v0.19.2
* Dropped `cache_args` to simplify cache functionality
* v0.19.1
* Fixed a bug of division by 0
* Replaced Travis-ci tests with github actions
* v0.19.0
* Fixed windows support
* v0.17.3
* Fixed a math error where the completion %age of a folder was wrong
* Fixes on the `.potodoignore` file
* v0.17.0
* Added tests
* Fixed bug where github would rate limit your IP address
* Fixed argument errors
* Added `-l` `--matching-files` Which will print the path of files matching your arguments
* v0.16.0
* Args passed to potodo are now cached as well ! This allows for a better control of what is cached !
* The ignore file now works as the .gitignore does. Add a venv/ in your .potodoignore for example :)
* v0.15.0
* Potodo now supports .potodoignore files ! You can finally ignore the venv you made 🎉
* v0.14.3
* Added cache versioning to avoid errors when cache changes, for example if files are moved between `potodo` versions.
* v0.14.2
* Nothing new, just code moved around ! Thanks for sticking around 🎉
* v0.14.1
* Added `--only-reserved` option to display only reserved filed
* Added `--reserved-dates` to display when a file was reserved
* Added cache to cache `pofiles` to speedup the reading process
* Added logging for verbosity
* Added interactive option with `--interactive`
* Added contributors in the readme
* < v0.14.1
* Base version
## Contributing
1. Fork it (<https://git.afpy.org/repo/fork/100>)
2. Create your feature branch (`git checkout -b feature/fooBar`
`/!\` Don't forget to bump the version in `potodo/__init__.py` when you're pushing your changes to your branch
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
Raw data
{
"_id": null,
"home_page": "",
"name": "potodo",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "potodo,gettext,i18n",
"author": "",
"author_email": "Jules Lasne <jules.lasne@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2d/96/6662df73d4b674fe0fd5bd05f17828336c7f41fdf3766a522cce105ae2bd/potodo-0.21.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=60% src=\"https://git.afpy.org/AFPy/potodo/raw/branch/main/media/Potodo.png\">\n</p>\n<p align=\"center\">\n <img src=\"https://img.shields.io/pypi/v/potodo\">\n <img src=\"https://img.shields.io/badge/python-v3.6+-blue.svg\">\n <img src=\"https://img.shields.io/badge/license-MIT-blue.svg\">\n <img src=\"https://img.shields.io/badge/contributions-welcome-orange.svg\">\n</p>\n\n## What is it ?\n\nPotodo, a (almost) flawless TODO/progress listing CLI tool for po files.\n\n### Potodo is part of poutils!\n\n[Poutils](https://pypi.org/project/poutils) (`.po` utils) is is a metapackage to easily install usefull Python tools to use with po files\nand `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!\n\n\n## Installation\n\n```sh\npip install potodo\n```\n\n## Usage example\n\n```\nusage: potodo [-h] [-p path] [-e path [path ...]] [-a X] [-b X] [-f] [-u API_URL] [-n] [-c] [-j] [--exclude-fuzzy] [--exclude-reserved]\n [--only-reserved] [--show-reservation-dates] [--no-cache] [-i] [-l] [--version] [-v]\n\nList and prettify the po files left to translate.\n\noptions:\n -h, --help show this help message and exit\n -p path, --path path execute Potodo in path\n -e path [path ...], --exclude path [path ...]\n gitignore-style patterns to exclude from search.\n -a X, --above X list all TODOs above given X% completion\n -b X, --below X list all TODOs below given X% completion\n -f, --only-fuzzy print only files marked as fuzzys\n -u API_URL, --api-url API_URL\n API URL to retrieve reservation tickets (https://api.github.com/repos/ORGANISATION/REPOSITORY/issues?state=open or\n https://git.afpy.org/api/v1/repos/ORGANISATION/REPOSITORY/issues?state=open&type=issues)\n -n, --no-reserved don't print info about reserved files\n -c, --counts render list with the count of remaining entries (translate or review) rather than percentage done\n -j, --json format output as JSON\n --exclude-fuzzy select only files without fuzzy entries\n --exclude-reserved select only files that aren't reserved\n --only-reserved select only only reserved files\n --show-reservation-dates\n show issue creation dates\n --no-cache Disables cache (Cache is disabled when files are modified)\n -i, --interactive Activates the interactive menu\n -l, --matching-files Suppress normal output; instead print the name of each matching po file from which output would normally have been\n printed.\n --version show program's version number and exit\n -v, --verbose Increases output verbosity\n```\n\n## Development setup\n\nCreate a virtual environment\n```sh\npython3 -m venv venv\n```\n\nActivate it\n```sh\nsource venv/bin/activate\n```\n\nInstall the dev requirements\n```sh\npip install -r requirements-dev.txt\n```\n\nInstall the pre-commit hook\n```sh\npre-commit install\n```\n\nInstall `potodo` in a development version\n```\npip install -e .\n```\n\n## Release History\n\n* v0.21.2\n * FIX: Don't miss issues (reservations) to files containing multiple dots. Contributed by @eviau.\n* v0.21.0\n * A nice new README\n* v0.20.0\n * New exclude behavior with gitignore style matching !\n* v0.19.2\n * Dropped `cache_args` to simplify cache functionality\n* v0.19.1\n * Fixed a bug of division by 0\n * Replaced Travis-ci tests with github actions\n* v0.19.0\n * Fixed windows support\n* v0.17.3\n * Fixed a math error where the completion %age of a folder was wrong\n * Fixes on the `.potodoignore` file\n* v0.17.0\n * Added tests\n * Fixed bug where github would rate limit your IP address\n * Fixed argument errors\n * Added `-l` `--matching-files` Which will print the path of files matching your arguments\n* v0.16.0\n * Args passed to potodo are now cached as well ! This allows for a better control of what is cached !\n * The ignore file now works as the .gitignore does. Add a venv/ in your .potodoignore for example :)\n* v0.15.0\n * Potodo now supports .potodoignore files ! You can finally ignore the venv you made \ud83c\udf89\n* v0.14.3\n * Added cache versioning to avoid errors when cache changes, for example if files are moved between `potodo` versions.\n* v0.14.2\n * Nothing new, just code moved around ! Thanks for sticking around \ud83c\udf89\n* v0.14.1\n * Added `--only-reserved` option to display only reserved filed\n * Added `--reserved-dates` to display when a file was reserved\n * Added cache to cache `pofiles` to speedup the reading process\n * Added logging for verbosity\n * Added interactive option with `--interactive`\n * Added contributors in the readme\n* < v0.14.1\n * Base version\n\n## Contributing\n\n1. Fork it (<https://git.afpy.org/repo/fork/100>)\n2. Create your feature branch (`git checkout -b feature/fooBar`\n\n`/!\\` Don't forget to bump the version in `potodo/__init__.py` when you're pushing your changes to your branch\n\n3. Commit your changes (`git commit -am 'Add some fooBar'`)\n4. Push to the branch (`git push origin feature/fooBar`)\n5. Create a new Pull Request\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "List .po files to be translated.",
"version": "0.21.3",
"split_keywords": [
"potodo",
"gettext",
"i18n"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bad36d10ee142e8f9ee1ae25c932a65a0fa77bce7309feb03528212154c126ea",
"md5": "3e0c998733b7a3c43ace0e4145af8a10",
"sha256": "2f0c603fba5b2a196a604cd7d7d8c3b84685a598184f6806dbf3dc1e3225f716"
},
"downloads": -1,
"filename": "potodo-0.21.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e0c998733b7a3c43ace0e4145af8a10",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13639,
"upload_time": "2023-03-25T13:31:55",
"upload_time_iso_8601": "2023-03-25T13:31:55.615878Z",
"url": "https://files.pythonhosted.org/packages/ba/d3/6d10ee142e8f9ee1ae25c932a65a0fa77bce7309feb03528212154c126ea/potodo-0.21.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d966662df73d4b674fe0fd5bd05f17828336c7f41fdf3766a522cce105ae2bd",
"md5": "240ab25f8934e572150418682aca53d6",
"sha256": "a5dbc51fd82476a2bab98f19163dcf87520c6eedd91872d32f07d5f59048abe3"
},
"downloads": -1,
"filename": "potodo-0.21.3.tar.gz",
"has_sig": false,
"md5_digest": "240ab25f8934e572150418682aca53d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 23160,
"upload_time": "2023-03-25T13:31:57",
"upload_time_iso_8601": "2023-03-25T13:31:57.124513Z",
"url": "https://files.pythonhosted.org/packages/2d/96/6662df73d4b674fe0fd5bd05f17828336c7f41fdf3766a522cce105ae2bd/potodo-0.21.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-25 13:31:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "potodo"
}
