A Command-Line Interface framework
Project description
Knack
_ _ | | ___ __ __ _ ___| | __ | |/ / '_ \ / _` |/ __| |/ / | <| | | | (_| | (__| < |_|\_\_| |_|\__,_|\___|_|\_\
A Command-Line Interface framework
Installation is easy via pip:
pip install knackKnack can be installed as a non-privileged user to your home directory by adding “–user” as below:
pip install knack --userUsage
import sys
from collections import OrderedDict
from knack import CLI, ArgumentsContext, CLICommandsLoader
from knack.commands import CommandGroup
def abc_str(length=3):
import string
return string.ascii_lowercase[:length]
class MyCommandsLoader(CLICommandsLoader):
def load_command_table(self, args):
with CommandGroup(self, 'abc', '__main__#{}') as g:
g.command('str', 'abc_str')
return OrderedDict(self.command_table)
def load_arguments(self, command):
with ArgumentsContext(self, 'abc str') as ac:
ac.argument('length', type=int)
super(MyCommandsLoader, self).load_arguments(command)
mycli = CLI(cli_name='mycli', commands_loader_cls=MyCommandsLoader)
exit_code = mycli.invoke(sys.argv[1:])
sys.exit(exit_code)
# $ python mycli.py abc str
# "abc"
# $ python mycli.py abc str --length 5
# "abcde"
# $ python mycli.py abc str --length 100
# "abcdefghijklmnopqrstuvwxyz"More samples and snippets are available at examples.
Documentation
Documentation is available at docs.
Developer Setup
In a virtual environment, install the requirements.txt file.
pip install -r requirements.txt
pip install -e .Run Automation
This project supports running automation using tox.
pip install tox
toxReal-world uses
Azure CLI: The Azure CLI 2.0 is Azure’s new command line experience for managing Azure resources.
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.
Service Fabric CLI: A command-line interface for interacting with Azure Service Fabric clusters and their related entities.
Do 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.
Release History
See GitHub Releases.
Contribute Code
This project has adopted the Microsoft Open Source Code of Conduct.
For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
If you would like to become an active contributor to this project, please follow the instructions provided in Contribution License Agreement.
License
Knack is licensed under MIT.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file knack-0.10.1.tar.gz.
File metadata
- Download URL: knack-0.10.1.tar.gz
- Upload date:
- Size: 72.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c5728128297e6d269791085cf96c2ffdfcef58cf83c634a5cb92eb03b2929838 |
|
| MD5 | 29419219946bbd919a1a4ba3295b0ebe |
|
| BLAKE2b-256 | 2e9cb6fc4ca774d3730fd1c2c9fe516afc223562976a4bcf0cec6e9e4dbf38c5 |
File details
Details for the file knack-0.10.1-py3-none-any.whl.
File metadata
- Download URL: knack-0.10.1-py3-none-any.whl
- Upload date:
- Size: 61.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 67bd5121b39ddb2683448aa7ccc9de46b2a2a3114a973239865d542b916e25b9 |
|
| MD5 | b704eb52c47208b54caa0cf8b0434740 |
|
| BLAKE2b-256 | 4059695a9c022d581f7ee58820920c2a13674f4f4b2c17e78f6c586669f68bae |
