[](https://github.com/pyTooling/pyTooling.CLIAbstraction)
[](LICENSE.md)
[](https://github.com/pyTooling/pyTooling.CLIAbstraction/tags)
[](https://github.com/pyTooling/pyTooling.CLIAbstraction/releases/latest)
[](https://github.com/pyTooling/pyTooling.CLIAbstraction/releases)
[](https://github.com/pyTooling/pyTooling.CLIAbstraction/network/dependents)
[](https://github.com/pyTooling/pyTooling.CLIAbstraction/actions/workflows/Pipeline.yml)
[](https://www.codacy.com/gh/pyTooling/pyTooling.CLIAbstraction)
[](https://www.codacy.com/gh/pyTooling/pyTooling.CLIAbstraction)
[](https://codecov.io/gh/pyTooling/pyTooling.CLIAbstraction)
[](https://libraries.io/github/pyTooling/pyTooling.CLIAbstraction/sourcerank)
[](https://pypi.org/project/pyTooling.CLIAbstraction/)
[](https://libraries.io/github/pyTooling/pyTooling.CLIAbstraction)
[](https://requires.io/github/pyTooling/pyTooling.CLIAbstraction/requirements/?branch=main)
[](https://pyTooling.CLIAbstraction.readthedocs.io/)
[](LICENSE.md)
[](https://pyTooling.CLIAbstraction.readthedocs.io/)
# pyTooling.CLIAbstraction
pyTooling.CLIAbstraction is an abstraction layer and wrapper for command line programs, so they can be used easily in
Python. All parameters like ``--value=42`` are described as parameters of the executable.
## Main Goals
* Offer access to CLI programs as Python classes.
* Abstract CLI arguments (a.k.a. parameter, option, flag, ...) as members on such a Python class.
* Derive program variants from existing programs.
* Assemble parameters in list format for handover to `subprocess.Popen` with proper escaping and quoting.
* Launch a program with `subprocess.Popen` and hide the complexity of Popen.
* Get a generator object for line-by-line output reading to enable postprocessing of outputs.
## Use Cases
* Wrap command line interfaces of EDA tools (Electronic Design Automation) in Python classes.
## Example
The following example implements a portion of the ``git`` program and its ``commit`` sub-command.
**Git program defining `commit` argument:**
```Python
from pyTooling.CLIAbstraction import CLIArgument, Executable
from pyTooling.CLIAbstraction.Command import CommandArgument
from pyTooling.CLIAbstraction.Flag import LongFlag
from pyTooling.CLIAbstraction.ValuedTupleFlag import ShortTupleFlag
class Git(Executable):
_executableNames = {
"Windows": "git.exe",
"Linux": "git",
"Darwin": "git"
}
@CLIArgument()
class FlagVerbose(LongFlag, name="verbose"):
"""Print verbose messages."""
@CLIArgument()
class CommandCommit(CommandArgument, name="commit"):
"""Command to commit staged files."""
@CLIArgument()
class ValueCommitMessage(ShortTupleFlag, name="m"):
"""Specify the commit message."""
def GetCommitTool(self):
"""Derive a new program from a configured program."""
tool = self.__class__(executablePath=self._executablePath)
tool[tool.CommandCommit] = True
self._CopyParameters(tool)
return tool
```
**Usage:**
```Python
# Create a program instance and set common parameters.
git = Git()
git[git.FlagVerbose] = True
# Derive a variant of that pre-configured program.
commit = git.getCommitTool()
commit[commit.ValueCommitMessage] = "Bumped dependencies."
# Launch the program and parse outputs line-by-line.
commit.StartProcess()
for line in commit.GetLineReader():
print(line)
```
# Consumers
This layer is used by:
* ✅ [pyEDAA.CLITool](https://github.com/edaa-org/pyEDAA.CLITool)
## Contributors
* [Patrick Lehmann](https://github.com/Paebbels) (Maintainer)
* [Unai Martinez-Corral](https://github.com/umarcor)
* [and more...](https://github.com/pyTooling/pyTooling.CLIAbstraction/graphs/contributors)
## License
This Python package (source code) licensed under [Apache License 2.0](LICENSE.md).
The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).
-------------------------
SPDX-License-Identifier: Apache-2.0
Raw data
{
"_id": null,
"home_page": "https://GitHub.com/pyTooling/pyTooling.CLIAbstraction",
"name": "pyTooling.CLIAbstraction",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "abstract,executable,cli,cli arguments",
"author": "Patrick Lehmann",
"author_email": "Paebbels@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/72/7f/b2e9aa19d94e9c1678960979e02a5f554f5c0d3e41aa62c9913643fc9c79/pyTooling.CLIAbstraction-0.4.1.tar.gz",
"platform": null,
"description": "[](https://github.com/pyTooling/pyTooling.CLIAbstraction)\n[](LICENSE.md)\n[](https://github.com/pyTooling/pyTooling.CLIAbstraction/tags)\n[](https://github.com/pyTooling/pyTooling.CLIAbstraction/releases/latest)\n[](https://github.com/pyTooling/pyTooling.CLIAbstraction/releases)\n[](https://github.com/pyTooling/pyTooling.CLIAbstraction/network/dependents) \n[](https://github.com/pyTooling/pyTooling.CLIAbstraction/actions/workflows/Pipeline.yml)\n[](https://www.codacy.com/gh/pyTooling/pyTooling.CLIAbstraction)\n[](https://www.codacy.com/gh/pyTooling/pyTooling.CLIAbstraction)\n[](https://codecov.io/gh/pyTooling/pyTooling.CLIAbstraction)\n[](https://libraries.io/github/pyTooling/pyTooling.CLIAbstraction/sourcerank) \n[](https://pypi.org/project/pyTooling.CLIAbstraction/)\n\n\n[](https://libraries.io/github/pyTooling/pyTooling.CLIAbstraction)\n[](https://requires.io/github/pyTooling/pyTooling.CLIAbstraction/requirements/?branch=main) \n[](https://pyTooling.CLIAbstraction.readthedocs.io/)\n[](LICENSE.md)\n[](https://pyTooling.CLIAbstraction.readthedocs.io/)\n\n# pyTooling.CLIAbstraction\n\npyTooling.CLIAbstraction is an abstraction layer and wrapper for command line programs, so they can be used easily in\nPython. All parameters like ``--value=42`` are described as parameters of the executable.\n\n\n## Main Goals\n\n* Offer access to CLI programs as Python classes.\n* Abstract CLI arguments (a.k.a. parameter, option, flag, ...) as members on such a Python class.\n* Derive program variants from existing programs.\n* Assemble parameters in list format for handover to `subprocess.Popen` with proper escaping and quoting.\n* Launch a program with `subprocess.Popen` and hide the complexity of Popen.\n* Get a generator object for line-by-line output reading to enable postprocessing of outputs.\n\n## Use Cases\n\n* Wrap command line interfaces of EDA tools (Electronic Design Automation) in Python classes.\n\n\n## Example\n\nThe following example implements a portion of the ``git`` program and its ``commit`` sub-command.\n\n**Git program defining `commit` argument:**\n\n```Python\nfrom pyTooling.CLIAbstraction import CLIArgument, Executable\nfrom pyTooling.CLIAbstraction.Command import CommandArgument\nfrom pyTooling.CLIAbstraction.Flag import LongFlag\nfrom pyTooling.CLIAbstraction.ValuedTupleFlag import ShortTupleFlag\n\nclass Git(Executable):\n\t_executableNames = {\n\t\t\"Windows\": \"git.exe\",\n\t\t\"Linux\": \"git\",\n\t\t\"Darwin\": \"git\"\n\t}\n\t\n\t@CLIArgument()\n\tclass FlagVerbose(LongFlag, name=\"verbose\"):\n\t\t\"\"\"Print verbose messages.\"\"\"\n\t\n\t@CLIArgument()\n\tclass CommandCommit(CommandArgument, name=\"commit\"):\n\t\t\"\"\"Command to commit staged files.\"\"\"\n\t\n\t@CLIArgument()\n\tclass ValueCommitMessage(ShortTupleFlag, name=\"m\"):\n\t\t\"\"\"Specify the commit message.\"\"\"\n\t\n\tdef GetCommitTool(self):\n\t\t\"\"\"Derive a new program from a configured program.\"\"\"\n\t\ttool = self.__class__(executablePath=self._executablePath)\n\t\ttool[tool.CommandCommit] = True\n\t\tself._CopyParameters(tool)\n\t\t\n\t\treturn tool\n```\n\n**Usage:**\n```Python\n# Create a program instance and set common parameters.\ngit = Git()\ngit[git.FlagVerbose] = True\n\n# Derive a variant of that pre-configured program.\ncommit = git.getCommitTool()\ncommit[commit.ValueCommitMessage] = \"Bumped dependencies.\"\n\n# Launch the program and parse outputs line-by-line.\ncommit.StartProcess()\nfor line in commit.GetLineReader():\n\tprint(line)\n```\n\n\n# Consumers\n\nThis layer is used by:\n\n* \u2705 [pyEDAA.CLITool](https://github.com/edaa-org/pyEDAA.CLITool)\n\n\n## Contributors\n* [Patrick Lehmann](https://github.com/Paebbels) (Maintainer)\n* [Unai Martinez-Corral](https://github.com/umarcor)\n* [and more...](https://github.com/pyTooling/pyTooling.CLIAbstraction/graphs/contributors)\n\n\n## License\n\nThis Python package (source code) licensed under [Apache License 2.0](LICENSE.md). \nThe accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).\n\n-------------------------\nSPDX-License-Identifier: Apache-2.0\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Basic abstraction layer for executables.",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://pyTooling.GitHub.io/pyTooling.CLIAbstraction",
"Homepage": "https://GitHub.com/pyTooling/pyTooling.CLIAbstraction",
"Issue Tracker": "https://GitHub.com/pyTooling/pyTooling.CLIAbstraction/issues",
"Source Code": "https://GitHub.com/pyTooling/pyTooling.CLIAbstraction"
},
"split_keywords": [
"abstract",
"executable",
"cli",
"cli arguments"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7e2887b6f2017253f8af583db98139317714bb76fcfc7a5b7374c03096730762",
"md5": "21b8933954e92aa8ffe577f3bc5fb3f3",
"sha256": "290ca69f8d977711162b0c38fbb947c6c24eeba89da1a6a1f26d39a727ce0592"
},
"downloads": -1,
"filename": "pyTooling.CLIAbstraction-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21b8933954e92aa8ffe577f3bc5fb3f3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 30872,
"upload_time": "2023-07-07T22:21:09",
"upload_time_iso_8601": "2023-07-07T22:21:09.753689Z",
"url": "https://files.pythonhosted.org/packages/7e/28/87b6f2017253f8af583db98139317714bb76fcfc7a5b7374c03096730762/pyTooling.CLIAbstraction-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "727fb2e9aa19d94e9c1678960979e02a5f554f5c0d3e41aa62c9913643fc9c79",
"md5": "3965230390136ee497f345b71ce08220",
"sha256": "62c675d743564638785df6fcdab9a54be6321b789f34dcc6ca18103d3cc303a6"
},
"downloads": -1,
"filename": "pyTooling.CLIAbstraction-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "3965230390136ee497f345b71ce08220",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20771,
"upload_time": "2023-07-07T22:21:08",
"upload_time_iso_8601": "2023-07-07T22:21:08.182656Z",
"url": "https://files.pythonhosted.org/packages/72/7f/b2e9aa19d94e9c1678960979e02a5f554f5c0d3e41aa62c9913643fc9c79/pyTooling.CLIAbstraction-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-07 22:21:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pytooling.cliabstraction"
}
JSON