Skip to content

Commit 15995ad

Browse files
committed
update README.md
1 parent c8f54ac commit 15995ad

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,40 @@
77
[click](https://click.palletsprojects.com) is the `Command line interface creation kit` and it helps you to create command line interfaces with some few lines of code. Click comes with meaningful defauls to make starting with it as easy as possible.
88

99
A powerful feature of click is to develop custom types to convert and/or validate user input. There are several custom types in the wild but this repository is intended to collect such custom types to make it easily accessable.
10+
11+
## Installation
12+
13+
Currently we support two ways of installing `click-types` on your system. We will both illustrate short in the following sections.
14+
15+
### Installing from pypi
16+
17+
We release all versions on [pypi.org](https://pypi.org/project/click-types/), so you can simply use `pip` to install it.
18+
19+
~~~bash
20+
pip install click-types
21+
~~~
22+
23+
### Install from repository
24+
25+
Alternatively you can install it from a local clone of our [github repository](https://github.com/codeaffen/click-types).
26+
27+
~~~bash
28+
$ git clone https://github.com/codeaffen/click-types.git
29+
Cloning into 'click-types'...
30+
remote: Enumerating objects: 83, done.
31+
remote: Counting objects: 100% (83/83), done.
32+
remote: Compressing objects: 100% (59/59), done.
33+
remote: Total 83 (delta 25), reused 72 (delta 16), pack-reused 0
34+
Unpacking objects: 100% (83/83), 29.77 KiB | 441.00 KiB/s, done.
35+
$ cd click-types/
36+
$ python setup.py install
37+
~~~
38+
39+
## Custom types
40+
41+
Name | Module | Description
42+
---- | ------ | -----------
43+
AnsibleVaultParamType | click_type.ansible | Manages secret values in ansible vaults. This type open the configured vault put the value to the given path and close vault.
44+
SemVerParamType | click_types.coding | Provides validity checks for semantic versions.
45+
CIDRParamType | click_types.net | Checking a given IP network/prefix if it's a valid CIDR. Both ip version (v4 and v6) are supported.
46+
VlanParamType | click_types.net | Validates vlan ids according to IEEE 802.1Q standard.

0 commit comments

Comments
 (0)