| Name | vale-cli JSON |
| Version |
0.2
JSON |
| download |
| home_page | None |
| Summary | A python wrapper for the Vale CLI tool. |
| upload_time | 2024-08-08 13:48:58 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Vale CLI Python Wrapper
[Vale](https://vale.sh/) is an open-source, command-line tool for validating
content based on editorial style rules. This package acts as a basic wrapper to
pass text to Vale and return styles rules that you can use in your Python
projects.
## Installation
**NOTE: This package only acts as a wrapper for using Vale and does not install
Vale. Make sure you install and configure Vale before using this package.**
Add `vale-cli` package as a dependency in your `requirements.txt` file:
```shell
vale-cli
```
## Usage
Example usage:
```python
import vale_cli.vale_config as vale_config
release_note = "An error with the WhizBang API caused incorrect processing of data, which stopped you from using certain routes in the API. This fix corrects the logic around data processing. You can now process data without errors."
vale = vale_config.ValeConfig("/path/to/.vale.ini")
output = vale.check_text(release_note, ext='.adoc')
print(output)
```
Output:
```shell
[{'Action': {'Name': '', 'Params': None}, 'Span': [19, 26], 'Check': 'RedHat.PascalCamelCase', 'Description': '', 'Link': 'https://redhat-documentation.github.io/asciidoc-markup-conventions', 'Message': "Consider wrapping this Pascal or Camel case term ('WhizBang') in backticks.", 'Severity': 'suggestion', 'Match': 'WhizBang', 'Line': 1}, {'Action': {'Name': 'replace', 'Params': ['wrong']}, 'Span': [39, 47], 'Check': 'RedHat.SimpleWords', 'Description': '', 'Link': 'https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/', 'Message': "Use simple language. Consider using 'wrong' rather than 'incorrect'.", 'Severity': 'suggestion', 'Match': 'incorrect', 'Line': 1}]
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vale-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Dan Macpherson <dmacpher@redhat.com>",
"download_url": "https://files.pythonhosted.org/packages/ba/b4/f49039b3c3ff2872c85a1688f3d18876e6277ed68edd51abce90f12f0ac5/vale_cli-0.2.tar.gz",
"platform": null,
"description": "# Vale CLI Python Wrapper\n\n[Vale](https://vale.sh/) is an open-source, command-line tool for validating\ncontent based on editorial style rules. This package acts as a basic wrapper to\npass text to Vale and return styles rules that you can use in your Python\nprojects.\n\n## Installation\n\n**NOTE: This package only acts as a wrapper for using Vale and does not install\nVale. Make sure you install and configure Vale before using this package.**\n\nAdd `vale-cli` package as a dependency in your `requirements.txt` file:\n\n```shell\nvale-cli\n```\n\n## Usage\n\nExample usage:\n\n```python\nimport vale_cli.vale_config as vale_config\n\nrelease_note = \"An error with the WhizBang API caused incorrect processing of data, which stopped you from using certain routes in the API. This fix corrects the logic around data processing. You can now process data without errors.\"\nvale = vale_config.ValeConfig(\"/path/to/.vale.ini\")\noutput = vale.check_text(release_note, ext='.adoc')\nprint(output)\n```\n\nOutput:\n\n```shell\n[{'Action': {'Name': '', 'Params': None}, 'Span': [19, 26], 'Check': 'RedHat.PascalCamelCase', 'Description': '', 'Link': 'https://redhat-documentation.github.io/asciidoc-markup-conventions', 'Message': \"Consider wrapping this Pascal or Camel case term ('WhizBang') in backticks.\", 'Severity': 'suggestion', 'Match': 'WhizBang', 'Line': 1}, {'Action': {'Name': 'replace', 'Params': ['wrong']}, 'Span': [39, 47], 'Check': 'RedHat.SimpleWords', 'Description': '', 'Link': 'https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/', 'Message': \"Use simple language. Consider using 'wrong' rather than 'incorrect'.\", 'Severity': 'suggestion', 'Match': 'incorrect', 'Line': 1}]\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python wrapper for the Vale CLI tool.",
"version": "0.2",
"project_urls": {
"Homepage": "https://github.com/danmacpherson/python-vale-cli",
"Issues": "https://github.com/danmacpherson/python-vale-cli/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7092e960974de5b2433626917e2ec3fee2fbb10863e317868cc396a7f701df3d",
"md5": "243e2c1cd8b6e3544fe233a88a4a56f9",
"sha256": "d0d68088b2cbb7d76274003dbbc82a87ecfe58f13f5f7118f863cebf98afe52c"
},
"downloads": -1,
"filename": "vale_cli-0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "243e2c1cd8b6e3544fe233a88a4a56f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3405,
"upload_time": "2024-08-08T13:48:57",
"upload_time_iso_8601": "2024-08-08T13:48:57.452908Z",
"url": "https://files.pythonhosted.org/packages/70/92/e960974de5b2433626917e2ec3fee2fbb10863e317868cc396a7f701df3d/vale_cli-0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bab4f49039b3c3ff2872c85a1688f3d18876e6277ed68edd51abce90f12f0ac5",
"md5": "ae603f2ca22ec6611f8358e09027a0ee",
"sha256": "b39cf5b8a96e78762b7601b3a5eb88b57e0e3bf0a13bb984633fa75d4d31d488"
},
"downloads": -1,
"filename": "vale_cli-0.2.tar.gz",
"has_sig": false,
"md5_digest": "ae603f2ca22ec6611f8358e09027a0ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3091,
"upload_time": "2024-08-08T13:48:58",
"upload_time_iso_8601": "2024-08-08T13:48:58.505911Z",
"url": "https://files.pythonhosted.org/packages/ba/b4/f49039b3c3ff2872c85a1688f3d18876e6277ed68edd51abce90f12f0ac5/vale_cli-0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-08 13:48:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "danmacpherson",
"github_project": "python-vale-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vale-cli"
}
