| Name | cliffold JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | https://github.com/bswck/cliffold |
| Summary | Analyze --help outputs of CLIs to generate programmatic client libraries. |
| upload_time | 2023-12-08 20:53:09 |
| maintainer | |
| docs_url | None |
| author | bswck |
| requires_python | >=3.8,<=3.12 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# cliffold [](https://pypi.org/project/cliffold/) [](https://pypi.org/project/cliffold/)
[](https://github.com/bswck/cliffold/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/cliffold)
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/psf/black)
[](https://github.com/bswck/cliffold/blob/HEAD/LICENSE)
[](https://github.com/pre-commit/pre-commit)
Analyze `--help` outputs of CLIs to generate programmatic client libraries.
# The idea
1. `cliffold scaffold-cli-lib git --dest=cliffold/git`
2. Thanks to `--help` output, cliffold generates a Python library that can be used to interact with the CLI:
```py
from cliffold.git import Git
git = Git()
print(git.version)
git.init()
git.commit(message="Initial commit")
```
To make this possible, `cliffold` is currently in its research and collects CLI outputs.
Feel free to submit your CLI propositions with installation methods in [#1](https://github.com/bswck/cliffold/issues/1).
See [cliffold_research.md](https://github.com/bswck/cliffold/blob/HEAD/cliffold_research.md) to check out the current research results.
# Installation
If you want to…
## …use this tool in your project 💻
You might simply install it with pip:
```shell
pip install cliffold
```
If you use [Poetry](https://python-poetry.org/), then run:
```shell
poetry add cliffold
```
## …contribute to [cliffold](https://github.com/bswck/cliffold) 🚀
<!--
This section was generated from bswck/skeleton@ea3be8a.
Instead of changing this particular file, you might want to alter the template:
https://github.com/bswck/skeleton/tree/ea3be8a/fragments/guide.md
-->
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [cliffold repository](https://github.com/bswck/cliffold) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
<sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>
Be sure to have Python 3.8 installed—if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:
```shell
pyenv install 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/cliffold path/to/cliffold
cd path/to/cliffold
poetry env use $(cat .python-version)
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install --hook-type pre-commit --hook-type pre-push
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/cliffold/blob/HEAD/CONTRIBUTING.md).<br/>
Always happy to accept contributions! ❤️
# Legal info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/cliffold/blob/HEAD/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/bswck/cliffold",
"name": "cliffold",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<=3.12",
"maintainer_email": "",
"keywords": "",
"author": "bswck",
"author_email": "bswck.dev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/89/312801d257aeb6bc047d490cf88954cbb4e63d52e749167bcbd09c5bdf88/cliffold-0.0.0.tar.gz",
"platform": null,
"description": "\n# cliffold [](https://pypi.org/project/cliffold/) [](https://pypi.org/project/cliffold/)\n[](https://github.com/bswck/cliffold/actions/workflows/test.yml)\n[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/cliffold)\n[](https://python-poetry.org/)\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/psf/black)\n[](https://github.com/bswck/cliffold/blob/HEAD/LICENSE)\n[](https://github.com/pre-commit/pre-commit)\n\nAnalyze `--help` outputs of CLIs to generate programmatic client libraries.\n\n# The idea\n\n1. `cliffold scaffold-cli-lib git --dest=cliffold/git`\n2. Thanks to `--help` output, cliffold generates a Python library that can be used to interact with the CLI:\n```py\nfrom cliffold.git import Git\n\ngit = Git()\nprint(git.version)\ngit.init()\ngit.commit(message=\"Initial commit\")\n```\n\nTo make this possible, `cliffold` is currently in its research and collects CLI outputs.\nFeel free to submit your CLI propositions with installation methods in [#1](https://github.com/bswck/cliffold/issues/1).\nSee [cliffold_research.md](https://github.com/bswck/cliffold/blob/HEAD/cliffold_research.md) to check out the current research results.\n\n# Installation\nIf you want to\u2026\n\n\n\n## \u2026use this tool in your project \ud83d\udcbb\nYou might simply install it with pip:\n\n```shell\npip install cliffold\n```\n\nIf you use [Poetry](https://python-poetry.org/), then run:\n\n```shell\npoetry add cliffold\n```\n\n## \u2026contribute to [cliffold](https://github.com/bswck/cliffold) \ud83d\ude80\n\n<!--\nThis section was generated from bswck/skeleton@ea3be8a.\nInstead of changing this particular file, you might want to alter the template:\nhttps://github.com/bswck/skeleton/tree/ea3be8a/fragments/guide.md\n-->\n\n> [!Note]\n> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).\n\n\n\n1. Fork the [cliffold repository](https://github.com/bswck/cliffold) on GitHub.\n\n1. [Install Poetry](https://python-poetry.org/docs/#installation).<br/>\n Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.\n You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):\n\n ```shell\n pipx install poetry\n ```\n\n <sub>If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.</sub>\n\n Be sure to have Python 3.8 installed\u2014if you use [pyenv](https://github.com/pyenv/pyenv#readme), simply run:\n\n ```shell\n pyenv install 3.8\n ```\n\n1. Clone your fork locally and install dependencies.\n\n ```shell\n git clone https://github.com/your-username/cliffold path/to/cliffold\n cd path/to/cliffold\n poetry env use $(cat .python-version)\n poetry install\n ```\n\n Next up, simply activate the virtual environment and install pre-commit hooks:\n\n ```shell\n poetry shell\n pre-commit install --hook-type pre-commit --hook-type pre-push\n ```\n\nFor more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/cliffold/blob/HEAD/CONTRIBUTING.md).<br/>\nAlways happy to accept contributions! \u2764\ufe0f\n\n\n# Legal info\n\u00a9 Copyright by Bartosz S\u0142awecki ([@bswck](https://github.com/bswck)).\n<br />This software is licensed under the terms of [MIT License](https://github.com/bswck/cliffold/blob/HEAD/LICENSE).\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Analyze --help outputs of CLIs to generate programmatic client libraries.",
"version": "0.0.0",
"project_urls": {
"Coverage": "https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/cliffold",
"Distribution": "https://pypi.org/project/cliffold/",
"Documentation": "https://cliffold.readthedocs.io/en/latest/",
"Homepage": "https://github.com/bswck/cliffold",
"Issues": "https://github.com/bswck/cliffold/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41e4daeff873bec1c9a7ba259e2ea55d1c50f99d22e04510a50e0d0aa1c4ec14",
"md5": "3402e81ef3cfa3c5bc1b6377e9d05128",
"sha256": "8df41533f8f9b008ab20132c8a969217575eeabca5d22adea52397c8db1650d9"
},
"downloads": -1,
"filename": "cliffold-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3402e81ef3cfa3c5bc1b6377e9d05128",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<=3.12",
"size": 3975,
"upload_time": "2023-12-08T20:53:08",
"upload_time_iso_8601": "2023-12-08T20:53:08.026903Z",
"url": "https://files.pythonhosted.org/packages/41/e4/daeff873bec1c9a7ba259e2ea55d1c50f99d22e04510a50e0d0aa1c4ec14/cliffold-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f89312801d257aeb6bc047d490cf88954cbb4e63d52e749167bcbd09c5bdf88",
"md5": "2b8b1255b5bb695a662dcdcaeb36c20c",
"sha256": "ad5cf5706c8c32ff0dfce36d7d81b2cdbcf9534536e10db1362712682b7d1cb4"
},
"downloads": -1,
"filename": "cliffold-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2b8b1255b5bb695a662dcdcaeb36c20c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<=3.12",
"size": 4755,
"upload_time": "2023-12-08T20:53:09",
"upload_time_iso_8601": "2023-12-08T20:53:09.545129Z",
"url": "https://files.pythonhosted.org/packages/0f/89/312801d257aeb6bc047d490cf88954cbb4e63d52e749167bcbd09c5bdf88/cliffold-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-08 20:53:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bswck",
"github_project": "cliffold",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cliffold"
}
