{"author":"Microsoft Corporation","author_email":"azpycli@microsoft.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","Intended Audience :: System Administrators","License :: OSI Approved :: MIT License","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":"Knack\n=====\n\n.. image:: https://img.shields.io/pypi/v/knack.svg\n :target: https://pypi.python.org/pypi/knack\n\n.. image:: https://img.shields.io/pypi/pyversions/knack.svg\n :target: https://pypi.python.org/pypi/knack\n\n.. image:: https://dev.azure.com/azure-sdk/public/_apis/build/status/cli/microsoft.knack?branchName=dev\n :target: https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1643&branchName=dev\n\n\n------------\n\n\n::\n\n _ _\n | | ___ __ __ _ ___| | __\n | |/ / '_ \\ / _` |/ __| |/ /\n | <| | | | (_| | (__| <\n |_|\\_\\_| |_|\\__,_|\\___|_|\\_\\\n\n\n**A Command-Line Interface framework**\n\nInstallation is easy via pip:\n\n.. code-block:: bash\n\n pip install knack\n\nKnack can be installed as a non-privileged user to your home directory by adding \"--user\" as below:\n\n.. code-block:: bash\n\n pip install knack --user\n\n------------\n\n.. note:: The project is in `initial development phase `__. We recommend pinning to at least a specific minor version when marking **knack** as a dependency in your project.\n\n------------\n\n\nUsage\n=====\n\n\n.. code-block:: python\n\n import sys\n from collections import OrderedDict\n\n from knack import CLI, ArgumentsContext, CLICommandsLoader\n from knack.commands import CommandGroup\n\n\n def abc_str(length=3):\n import string\n return string.ascii_lowercase[:length]\n\n\n class MyCommandsLoader(CLICommandsLoader):\n def load_command_table(self, args):\n with CommandGroup(self, 'abc', '__main__#{}') as g:\n g.command('str', 'abc_str')\n return OrderedDict(self.command_table)\n\n def load_arguments(self, command):\n with ArgumentsContext(self, 'abc str') as ac:\n ac.argument('length', type=int)\n super(MyCommandsLoader, self).load_arguments(command)\n\n\n mycli = CLI(cli_name='mycli', commands_loader_cls=MyCommandsLoader)\n exit_code = mycli.invoke(sys.argv[1:])\n sys.exit(exit_code)\n\n # $ python mycli.py abc str\n # \"abc\"\n\n # $ python mycli.py abc str --length 5\n # \"abcde\"\n\n # $ python mycli.py abc str --length 100\n # \"abcdefghijklmnopqrstuvwxyz\"\n\n\nMore samples and snippets are available at `examples `__.\n\n\nDocumentation\n=============\n\nDocumentation is available at `docs `__.\n\nDeveloper Setup\n===============\n\nIn a virtual environment, install the `requirements.txt` file.\n\n.. code-block:: bash\n\n pip install -r requirements.txt\n pip install -e .\n\nRun Automation\n==============\n\nThis project supports running automation using `tox `__.\n\n.. code-block:: bash\n\n pip install tox\n tox\n\n\nReal-world uses\n===============\n\n- `Azure CLI `__: The Azure CLI 2.0 is Azure's new command line experience for managing Azure resources.\n- `VSTS CLI `__: A command-line interface for Visual Studio Team Services (VSTS) and Team Foundation Server (TFS). With the VSTS CLI, you can manage and work with resources including pull requests, work items, builds, and more.\n- `Service Fabric CLI `__: A command-line interface for interacting with Azure Service Fabric clusters and their related entities.\n\nDo you use knack in your CLI as well? Open a pull request to include it here. We would love to have it in our list.\n\n\nRelease History\n===============\n\nSee `GitHub Releases `__.\n\n\nContribute Code\n===============\n\nThis project has adopted the `Microsoft Open Source Code of Conduct `__.\n\nFor more information see the `Code of Conduct FAQ `__ or contact `opencode@microsoft.com `__ with any additional questions or comments.\n\nIf you would like to become an active contributor to this project, please\nfollow the instructions provided in `Contribution License Agreement `__.\n\n\nLicense\n=======\n\nKnack is licensed under `MIT `__.\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/microsoft/knack","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"knack","package_url":"https://pypi.org/project/knack/","platform":null,"project_url":"https://pypi.org/project/knack/","project_urls":{"Homepage":"https://github.com/microsoft/knack"},"provides_extra":null,"release_url":"https://pypi.org/project/knack/0.12.0/","requires_dist":["argcomplete","jmespath","packaging","pygments","pyyaml","tabulate"],"requires_python":null,"summary":"A Command-Line Interface framework","version":"0.12.0","yanked":false,"yanked_reason":null}

Dependency	Optional
argcomplete	false
jmespath	false
packaging	false
pygments	false
pyyaml	false
tabulate	false

Package search

knack

project_urls

Dependencies

All package metadata

Releases