| Name | interfacy JSON |
| Version |
0.3.4
JSON |
| download |
| home_page | None |
| Summary | Interfacy is a library for automatically generating CLI applications from Python functions, methods, classes, or instances using their type annotations and docstrings. |
| upload_time | 2025-10-21 17:35:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License
Copyright (c) 2023 Žiga Ivanšek
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 |
argparse
cli
cli-builder
cli-framework
cli-generator
command-line
interfacy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Interfacy
[](https://badge.fury.io/py/interfacy)
[](https://pepy.tech/project/interfacy)
[](https://github.com/zigai/interfacy/blob/main/LICENSE)
Interfacy is a library for automatically generating CLI applications from Python functions, methods, classes, or instances using their type annotations and docstrings.
## Features
- CLI generation from functions, methods, classes, or instances.
- Argument type inference from annotations.
- Required parameters as positionals or flags.
- Subcommands with optional aliases.
- Multiple help text themes.
- Stdin piping support.
- Optional tab completion via argcomplete.
- Support for user-defined type parsers.
## Installation
### From PyPI
```bash
pip install interfacy
```
```bash
uv add interfacy
```
### From Source
```bash
pip install git+https://github.com/zigai/interfacy.git
```
```bash
uv add "git+https://github.com/zigai/interfacy.git"
```
## Example
```python
def greet(name: str, times: int = 1) -> None:
for _ in range(times):
print(f"Hello, {name}!")
if __name__ == "__main__":
from interfacy import Argparser
Argparser(print_result=True).run(greet)
```
## License
[MIT License](https://github.com/zigai/interfacy/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "interfacy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "argparse, cli, cli-builder, cli-framework, cli-generator, command-line, interfacy",
"author": null,
"author_email": "\u017diga Ivan\u0161ek <ziga.ivansek@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/23/86/c8adbab79dda14d7e7c2f609696c9319af9896c18662ed1f02400c52dc4f/interfacy-0.3.4.tar.gz",
"platform": null,
"description": "# Interfacy\n\n[](https://badge.fury.io/py/interfacy)\n\n[](https://pepy.tech/project/interfacy)\n[](https://github.com/zigai/interfacy/blob/main/LICENSE)\n\nInterfacy is a library for automatically generating CLI applications from Python functions, methods, classes, or instances using their type annotations and docstrings.\n\n## Features\n\n- CLI generation from functions, methods, classes, or instances.\n- Argument type inference from annotations.\n- Required parameters as positionals or flags.\n- Subcommands with optional aliases.\n- Multiple help text themes.\n- Stdin piping support.\n- Optional tab completion via argcomplete.\n- Support for user-defined type parsers.\n\n## Installation\n\n### From PyPI\n\n```bash\npip install interfacy\n```\n\n```bash\nuv add interfacy\n```\n\n### From Source\n\n```bash\npip install git+https://github.com/zigai/interfacy.git\n```\n\n```bash\nuv add \"git+https://github.com/zigai/interfacy.git\"\n```\n\n## Example\n\n```python\ndef greet(name: str, times: int = 1) -> None:\n for _ in range(times):\n print(f\"Hello, {name}!\")\n\nif __name__ == \"__main__\":\n from interfacy import Argparser\n Argparser(print_result=True).run(greet)\n```\n\n## License\n\n[MIT License](https://github.com/zigai/interfacy/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2023 \u017diga Ivan\u0161ek\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Interfacy is a library for automatically generating CLI applications from Python functions, methods, classes, or instances using their type annotations and docstrings.",
"version": "0.3.4",
"project_urls": {
"Repository": "https://github.com/zigai/interfacy"
},
"split_keywords": [
"argparse",
" cli",
" cli-builder",
" cli-framework",
" cli-generator",
" command-line",
" interfacy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d36ef5f0d5d0708d3f59a9290a0cee20a42c3a0e7441044a3b4bba569a060cac",
"md5": "5de46ac8d23bafe79be71055845c599b",
"sha256": "64d64893a0d386094f8717d2534aaf215d1d66e19922941f663ca02daa3ff0d0"
},
"downloads": -1,
"filename": "interfacy-0.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5de46ac8d23bafe79be71055845c599b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 46821,
"upload_time": "2025-10-21T17:35:08",
"upload_time_iso_8601": "2025-10-21T17:35:08.825189Z",
"url": "https://files.pythonhosted.org/packages/d3/6e/f5f0d5d0708d3f59a9290a0cee20a42c3a0e7441044a3b4bba569a060cac/interfacy-0.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2386c8adbab79dda14d7e7c2f609696c9319af9896c18662ed1f02400c52dc4f",
"md5": "b7a3b106bf5be581a2cd86014f3ff19f",
"sha256": "e59ff0fd9ab1c936820cc035c04b5a583c81cfc97dc52d71873383e106471411"
},
"downloads": -1,
"filename": "interfacy-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "b7a3b106bf5be581a2cd86014f3ff19f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 61730,
"upload_time": "2025-10-21T17:35:09",
"upload_time_iso_8601": "2025-10-21T17:35:09.898030Z",
"url": "https://files.pythonhosted.org/packages/23/86/c8adbab79dda14d7e7c2f609696c9319af9896c18662ed1f02400c52dc4f/interfacy-0.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-21 17:35:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zigai",
"github_project": "interfacy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "interfacy"
}
