| Name | argapp JSON |
| Version |
0.7.2
JSON |
| download |
| home_page | |
| Summary | A Python package for CLI application development |
| upload_time | 2024-02-25 10:11:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2023 Volodymyr Zakalyk Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# argapp - A Python package for CLI application development
# Overview
argapp is an OOP wrapper for [argparse](https://docs.python.org/3/library/argparse.html) and [argcomplete](https://pypi.org/project/argcomplete):
* Allows writing CLI applications using OOP - encapsulates [argparse](https://docs.python.org/3/library/argparse.html) API.
* Provides limited support for the shell completion via [argcomplete](https://pypi.org/project/argcomplete).
Full documentation is available at https://deohayer.github.io/argapp-ws.
## Features
* Offers several classes for CLI parsing via OOP.
* `Arg` represents optional and positional arguments, with the most essential use cases covered.
* `App` represents a main command or a subcommand.
* The fields are validated upon construction or setting, raising an `Exception` in case of any issues.
* The parsing can be overridden by subclassing `Arg`.
* Offers shell completion support if argcomplete is installed:
* The required API calls are already in place. It is only required to install argcomplete and add the `PYTHON_ARGCOMPLETE_OK` comment to the script.
* Specific completions are added automatically.
## Dependencies
* Linux
* Python 3
* 3.6
* 3.7
* 3.8
* 3.9
* 3.10
* 3.11
## Installation
* The package can be installed globally by running:
```shell
pip3 install argapp
```
* The Git [repository](https://github.com/deohayer/argapp) can be used directly.
The repository layout is designed with exactly this use case in mind.
* For the argcomplete installation, please follow the official [documentation](https://pypi.org/project/argcomplete).
## Limitations
* No abbreviated optional arguments.
* No argument groups of any kind.
* No partial parsing.
* `argcomplete.autocomplete()` call is hidden and cannot be parametrized.
* The completion has no test coverage.
Raw data
{
"_id": null,
"home_page": "",
"name": "argapp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "Volodymyr Zakalyk <volodymyr.zakalyk@gmail.com>",
"keywords": "cli",
"author": "",
"author_email": "Volodymyr Zakalyk <volodymyr.zakalyk@gmail.com>",
"download_url": "",
"platform": null,
"description": "# argapp - A Python package for CLI application development\n\n# Overview\n\nargapp is an OOP wrapper for [argparse](https://docs.python.org/3/library/argparse.html) and [argcomplete](https://pypi.org/project/argcomplete):\n * Allows writing CLI applications using OOP - encapsulates [argparse](https://docs.python.org/3/library/argparse.html) API.\n * Provides limited support for the shell completion via [argcomplete](https://pypi.org/project/argcomplete).\n\nFull documentation is available at https://deohayer.github.io/argapp-ws.\n\n## Features\n\n * Offers several classes for CLI parsing via OOP.\n * `Arg` represents optional and positional arguments, with the most essential use cases covered.\n * `App` represents a main command or a subcommand.\n * The fields are validated upon construction or setting, raising an `Exception` in case of any issues.\n * The parsing can be overridden by subclassing `Arg`.\n * Offers shell completion support if argcomplete is installed:\n * The required API calls are already in place. It is only required to install argcomplete and add the `PYTHON_ARGCOMPLETE_OK` comment to the script.\n * Specific completions are added automatically.\n\n## Dependencies\n\n * Linux\n * Python 3\n * 3.6\n * 3.7\n * 3.8\n * 3.9\n * 3.10\n * 3.11\n\n## Installation\n\n * The package can be installed globally by running:\n ```shell\n pip3 install argapp\n ```\n * The Git [repository](https://github.com/deohayer/argapp) can be used directly.\n The repository layout is designed with exactly this use case in mind.\n * For the argcomplete installation, please follow the official [documentation](https://pypi.org/project/argcomplete).\n\n## Limitations\n\n * No abbreviated optional arguments.\n * No argument groups of any kind.\n * No partial parsing.\n * `argcomplete.autocomplete()` call is hidden and cannot be parametrized.\n * The completion has no test coverage.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Volodymyr Zakalyk Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Python package for CLI application development",
"version": "0.7.2",
"project_urls": {
"Repository": "https://github.com/deohayer/argapp.git"
},
"split_keywords": [
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b32e32e5faa66b88152d6704d2047f9176223db0150901cbce19680ab6a76e0",
"md5": "4578d00a29d829db4a6be6faa007e52e",
"sha256": "333212920a3bc30e60100be1c31cdae7077623b92eba26b551d45fa0f980f8a4"
},
"downloads": -1,
"filename": "argapp-0.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4578d00a29d829db4a6be6faa007e52e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 15485,
"upload_time": "2024-02-25T10:11:39",
"upload_time_iso_8601": "2024-02-25T10:11:39.270288Z",
"url": "https://files.pythonhosted.org/packages/0b/32/e32e5faa66b88152d6704d2047f9176223db0150901cbce19680ab6a76e0/argapp-0.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-25 10:11:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deohayer",
"github_project": "argapp",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "argapp"
}
