| Name | clias JSON |
| Version |
0.1.0a1
JSON |
| download |
| home_page | None |
| Summary | Turn shell script into cli command |
| upload_time | 2024-10-21 10:28:42 |
| maintainer | None |
| docs_url | None |
| author | kj-9 |
| requires_python | >=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# clias
[](https://pypi.org/project/clias/)
[](https://github.com/kj-9/clias/releases)
[](https://github.com/kj-9/clias/actions/workflows/ci.yml)
[](https://github.com/kj-9/clias/blob/master/LICENSE)
Turn shell script into CLIs
## Installation
Install this tool using `pip`:
```bash
pip install clias
```
## Usage
For help, run:
<!-- [[[cog
import cog
from clias import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["--help"])
help = result.output.replace("Usage: cli", "Usage: clias")
cog.out(
f"```bash\n{help}\n```"
)
]]] -->
```bash
Usage: clias [OPTIONS] COMMAND [ARGS]...
Turn shell script into cli command
Options:
-d, --dryrun dry run mode, only show the rendered command
--version Show the version and exit.
--help Show this message and exit.
Commands:
info Show the clias config file path to be loaded
```
<!-- [[[end]]] -->
You can also use:
```bash
python -m clias --help
```
## Development
To contribute to this tool, first checkout the code. Then create a new virtual environment:
```bash
cd clias
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
make install-e
```
To run the tests:
```bash
make test
```
To run pre-commit to lint and format:
```bash
make check
```
`make check` detects if cli help message in `README.md` is outdated and updates it.
To update cli help message `README.md`:
```bash
make readme
```
this runs [cog](https://cog.readthedocs.io/en/latest/) on README.md and updates the help message inside it.
Raw data
{
"_id": null,
"home_page": null,
"name": "clias",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "kj-9",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/69/ed/783bf4845287f85c981de876390ad2c4a68a486b5187fba5ac59cd0dca16/clias-0.1.0a1.tar.gz",
"platform": null,
"description": "# clias\n\n[](https://pypi.org/project/clias/)\n[](https://github.com/kj-9/clias/releases)\n[](https://github.com/kj-9/clias/actions/workflows/ci.yml)\n[](https://github.com/kj-9/clias/blob/master/LICENSE)\n\nTurn shell script into CLIs\n\n## Installation\n\nInstall this tool using `pip`:\n```bash\npip install clias\n```\n## Usage\n\nFor help, run:\n<!-- [[[cog\nimport cog\nfrom clias import cli\nfrom click.testing import CliRunner\nrunner = CliRunner()\nresult = runner.invoke(cli.cli, [\"--help\"])\nhelp = result.output.replace(\"Usage: cli\", \"Usage: clias\")\ncog.out(\n f\"```bash\\n{help}\\n```\"\n)\n]]] -->\n```bash\nUsage: clias [OPTIONS] COMMAND [ARGS]...\n\n Turn shell script into cli command\n\nOptions:\n -d, --dryrun dry run mode, only show the rendered command\n --version Show the version and exit.\n --help Show this message and exit.\n\nCommands:\n info Show the clias config file path to be loaded\n\n```\n<!-- [[[end]]] -->\n\nYou can also use:\n```bash\npython -m clias --help\n```\n## Development\n\nTo contribute to this tool, first checkout the code. Then create a new virtual environment:\n```bash\ncd clias\npython -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\nmake install-e\n```\nTo run the tests:\n```bash\nmake test\n```\n\nTo run pre-commit to lint and format:\n```bash\nmake check\n```\n\n`make check` detects if cli help message in `README.md` is outdated and updates it.\n\nTo update cli help message `README.md`:\n```bash\nmake readme\n```\n\nthis runs [cog](https://cog.readthedocs.io/en/latest/) on README.md and updates the help message inside it.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Turn shell script into cli command",
"version": "0.1.0a1",
"project_urls": {
"CI": "https://github.com/kj-9/clias/actions",
"Changelog": "https://github.com/kj-9/clias/releases",
"Homepage": "https://github.com/kj-9/clias",
"Issues": "https://github.com/kj-9/clias/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3afc8f30ef55d9eef722e59f621f31eb967d4a17718bc69369dffca9c7243da7",
"md5": "be058ca8fe73bb5f0138a0a45022e11d",
"sha256": "2185f5bcac595cbf4b844d1f200197aca9007aca19cafd7dbb3d4b2a6fed3d3b"
},
"downloads": -1,
"filename": "clias-0.1.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be058ca8fe73bb5f0138a0a45022e11d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8946,
"upload_time": "2024-10-21T10:28:41",
"upload_time_iso_8601": "2024-10-21T10:28:41.378359Z",
"url": "https://files.pythonhosted.org/packages/3a/fc/8f30ef55d9eef722e59f621f31eb967d4a17718bc69369dffca9c7243da7/clias-0.1.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "69ed783bf4845287f85c981de876390ad2c4a68a486b5187fba5ac59cd0dca16",
"md5": "c86e3f275a771a90d7b7ba552d95e6f2",
"sha256": "87b57a7a069f2c74cd4a519316dab0ae932e40c312b784e3d8d2ff9273bcbfef"
},
"downloads": -1,
"filename": "clias-0.1.0a1.tar.gz",
"has_sig": false,
"md5_digest": "c86e3f275a771a90d7b7ba552d95e6f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8943,
"upload_time": "2024-10-21T10:28:42",
"upload_time_iso_8601": "2024-10-21T10:28:42.774258Z",
"url": "https://files.pythonhosted.org/packages/69/ed/783bf4845287f85c981de876390ad2c4a68a486b5187fba5ac59cd0dca16/clias-0.1.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 10:28:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kj-9",
"github_project": "clias",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "clias"
}
