# pospell
`pospell` is a spellcheckers for po files containing reStructuredText.
## Pospell is part of poutils!
[Poutils](https://pypi.org/project/poutils) (`.po` utils) is a metapackage to easily install useful Python tools to use with po files
and `pospell` is a part of it! Go check out [Poutils](https://pypi.org/project/poutils) to discover the other tools!
## Examples
By giving files to `pospell`:
```
$ pospell --language fr about.po
about.po:47:Jr.
about.po:55:reStructuredText
about.po:55:Docutils
about.po:63:Fredrik
about.po:63:Lundh
about.po:75:language
about.po:75:librarie
```
By using a bash expansion (note that we do not put quotes around
`*.po` to let bash do its expansion):
```
$ pospell --language fr *.po
…
```
By using a glob pattern (note that we *do* put quotes around `**/*.po`
to keep your shell from trying to expand it, we'll let Python do the
expansion:
```
$ pospell --language fr --glob '**/*.po'
…
```
## Usage
```
usage: pospell [-h] [-l LANGUAGE] [--glob GLOB] [--debug] [-p PERSONAL_DICT]
[po_file [po_file ...]]
Check spelling in po files containing restructuredText.
positional arguments:
po_file Files to check, can optionally be mixed with --glob,
or not, use the one that fit your needs.
optional arguments:
-h, --help show this help message and exit
-l LANGUAGE, --language LANGUAGE
Language to check, you'll have to install the
corresponding hunspell dictionary, on Debian see apt
list 'hunspell-*'.
--glob GLOB Provide a glob pattern, to be interpreted by pospell,
to find po files, like --glob '**/*.po'.
--debug
-p PERSONAL_DICT, --personal-dict PERSONAL_DICT
```
A personal dict (the `-p` option) is simply a text file with one word
per line.
## Contributing
You can work in a venv, to install the project locally:
```bash
python -m pip install .
```
And to test it locally:
```bash
python -m pip install tox
tox -p all
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pospell",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "po,spell,gettext,reStructuredText,check,sphinx,translation",
"author": "",
"author_email": "Julien Palard <julien@palard.fr>",
"download_url": "https://files.pythonhosted.org/packages/fe/99/6f867bbe463924a1d8f56ffcf8f289540a70d6df0c43116eaf1f6244ae95/pospell-1.3.tar.gz",
"platform": null,
"description": "# pospell\n\n`pospell` is a spellcheckers for po files containing reStructuredText.\n\n\n## Pospell is part of poutils!\n\n[Poutils](https://pypi.org/project/poutils) (`.po` utils) is a metapackage to easily install useful Python tools to use with po files\nand `pospell` is a part of it! Go check out [Poutils](https://pypi.org/project/poutils) to discover the other tools!\n\n\n## Examples\n\nBy giving files to `pospell`:\n```\n$ pospell --language fr about.po\nabout.po:47:Jr.\nabout.po:55:reStructuredText\nabout.po:55:Docutils\nabout.po:63:Fredrik\nabout.po:63:Lundh\nabout.po:75:language\nabout.po:75:librarie\n```\n\nBy using a bash expansion (note that we do not put quotes around\n`*.po` to let bash do its expansion):\n\n```\n$ pospell --language fr *.po\n\u2026\n```\n\nBy using a glob pattern (note that we *do* put quotes around `**/*.po`\nto keep your shell from trying to expand it, we'll let Python do the\nexpansion:\n\n```\n$ pospell --language fr --glob '**/*.po'\n\u2026\n```\n\n\n## Usage\n\n```\nusage: pospell [-h] [-l LANGUAGE] [--glob GLOB] [--debug] [-p PERSONAL_DICT]\n [po_file [po_file ...]]\n\nCheck spelling in po files containing restructuredText.\n\npositional arguments:\n po_file Files to check, can optionally be mixed with --glob,\n or not, use the one that fit your needs.\n\noptional arguments:\n -h, --help show this help message and exit\n -l LANGUAGE, --language LANGUAGE\n Language to check, you'll have to install the\n corresponding hunspell dictionary, on Debian see apt\n list 'hunspell-*'.\n --glob GLOB Provide a glob pattern, to be interpreted by pospell,\n to find po files, like --glob '**/*.po'.\n --debug\n -p PERSONAL_DICT, --personal-dict PERSONAL_DICT\n```\n\nA personal dict (the `-p` option) is simply a text file with one word\nper line.\n\n\n## Contributing\n\nYou can work in a venv, to install the project locally:\n\n```bash\npython -m pip install .\n```\n\nAnd to test it locally:\n\n```bash\npython -m pip install tox\ntox -p all\n```\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Spellcheck .po files containing reStructuredText translations",
"version": "1.3",
"project_urls": {
"Homepage": "https://git.afpy.org/AFPy/pospell"
},
"split_keywords": [
"po",
"spell",
"gettext",
"restructuredtext",
"check",
"sphinx",
"translation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d466da37a38f95fafa0b12411ea7c5b18eba6ca205419161b02ebec3c280837c",
"md5": "06bcfef66f2e3c327fced5701a1a1b21",
"sha256": "26db89967a9e08adc2d2d7e994c9a6cc9180d8801749ae5f2e35e9e8043d22d3"
},
"downloads": -1,
"filename": "pospell-1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06bcfef66f2e3c327fced5701a1a1b21",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7940,
"upload_time": "2023-07-21T07:08:43",
"upload_time_iso_8601": "2023-07-21T07:08:43.372775Z",
"url": "https://files.pythonhosted.org/packages/d4/66/da37a38f95fafa0b12411ea7c5b18eba6ca205419161b02ebec3c280837c/pospell-1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe996f867bbe463924a1d8f56ffcf8f289540a70d6df0c43116eaf1f6244ae95",
"md5": "5021e4e53fa7c62d6f85260db42210af",
"sha256": "20ebf43ce82b59fcfc3c2e2ad16accaf23a6eab345b25e1aeb33f2fa5010d4a9"
},
"downloads": -1,
"filename": "pospell-1.3.tar.gz",
"has_sig": false,
"md5_digest": "5021e4e53fa7c62d6f85260db42210af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8578,
"upload_time": "2023-07-21T07:08:45",
"upload_time_iso_8601": "2023-07-21T07:08:45.239883Z",
"url": "https://files.pythonhosted.org/packages/fe/99/6f867bbe463924a1d8f56ffcf8f289540a70d6df0c43116eaf1f6244ae95/pospell-1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-21 07:08:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pospell"
}
JSON