Skip to content

Commit 9829ca1

Browse files
authored
Assorted README updates (#57)
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
1 parent 0e4addd commit 9829ca1

1 file changed

Lines changed: 6 additions & 112 deletions

File tree

README.md

Lines changed: 6 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![codecov](https://codecov.io/github/ansible/ansible-creator/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-creator)
12
![PyPI - Status](https://img.shields.io/pypi/status/ansible-creator)
23
![PyPI - Version](https://img.shields.io/pypi/v/ansible-creator)
34
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ansible-creator)
@@ -11,13 +12,11 @@ A CLI tool for scaffolding all your Ansible Content.
1112

1213
## Installation
1314

14-
```
15+
```shell
1516
$ pip install ansible-creator
1617
```
1718

18-
## Usage
19-
20-
```
19+
```shell
2120
$ ansible-creator --help
2221
usage: ansible-creator [-h] [--version] {init} ...
2322

@@ -32,116 +31,11 @@ Commands:
3231
init Initialize an Ansible Collection.
3332
```
3433

35-
### Initialize an Ansible Collection skeleton with 'init'
36-
37-
```
38-
$ ansible-creator init --help
39-
usage: ansible-creator init [-h] [--na] [--lf LOG_FILE] [--ll {notset,debug,info,warning,error,critical}] [--la {true,false}] [--json] [-v]
40-
[--init-path INIT_PATH] [--force]
41-
collection
42-
43-
Creates the skeleton framework of an Ansible collection.
44-
45-
positional arguments:
46-
collection The collection name in the format ``<namespace>.<collection>``.
47-
48-
optional arguments:
49-
-h, --help show this help message and exit
50-
--na, --no-ansi Disable the use of ANSI codes for terminal color.
51-
--lf LOG_FILE, --log-file <file> LOG_FILE
52-
Log file to write to.
53-
--ll {notset,debug,info,warning,error,critical}, --log-level <level> {notset,debug,info,warning,error,critical}
54-
Log level for file output.
55-
--la {true,false}, --log-append <bool> {true,false}
56-
Append to log file.
57-
--json Output messages as JSON
58-
-v, --verbose Give more Cli output. Option is additive, and can be used up to 3 times.
59-
--init-path INIT_PATH
60-
The path in which the skeleton collection will be created. The default is the current working directory.
61-
--force Force re-initialize the specified directory as an Ansible collection.
62-
```
63-
64-
```
65-
$ ansible-creator init testns.testname --init-path $HOME/collections/ansible_collections
66-
Note: collection testns.testname created at /home/ansible-dev/collections/ansible_collections
67-
```
68-
69-
Running the above command generates an Ansible Collection with the following structure:
34+
## Usage
7035

71-
```
72-
$ tree -lla /home/ansible-dev/collections/ansible_collections
73-
.
74-
├── CHANGELOG.rst
75-
├── changelogs
76-
│ └── config.yaml
77-
├── CODE_OF_CONDUCT.md
78-
├── CONTRIBUTING
79-
├── docs
80-
│ ├── docsite
81-
│ │ └── links.yml
82-
│ └── .keep
83-
├── extensions
84-
│ ├── eda
85-
│ │ └── rulebooks
86-
│ │ └── rulebook.yml
87-
│ └── molecule
88-
│ ├── integration_hello_world
89-
│ │ └── molecule.yml
90-
│ └── utils
91-
│ ├── playbooks
92-
│ │ ├── converge.yml
93-
│ │ └── noop.yml
94-
│ └── vars
95-
│ └── vars.yml
96-
├── galaxy.yml
97-
├── .github
98-
│ └── workflows
99-
│ └── test.yml
100-
├── .isort.cfg
101-
├── LICENSE
102-
├── MAINTAINERS
103-
├── meta
104-
│ └── runtime.yml
105-
├── plugins
106-
│ ├── action
107-
│ │ └── __init__.py
108-
│ ├── cache
109-
│ │ └── __init__.py
110-
│ ├── filter
111-
│ │ ├── hello_world.py
112-
│ │ └── __init__.py
113-
│ ├── inventory
114-
│ │ └── __init__.py
115-
│ ├── modules
116-
│ │ └── __init__.py
117-
│ ├── module_utils
118-
│ │ └── __init__.py
119-
│ ├── plugin_utils
120-
│ │ └── __init__.py
121-
│ ├── sub_plugins
122-
│ │ └── __init__.py
123-
│ └── test
124-
│ └── __init__.py
125-
├── .pre-commit-config.yaml
126-
├── .prettierignore
127-
├── pyproject.toml
128-
├── README.md
129-
├── tests
130-
│ ├── .gitignore
131-
│ ├── integration
132-
│ │ ├── __init__.py
133-
│ │ ├── targets
134-
│ │ │ └── hello_world
135-
│ │ │ └── tasks
136-
│ │ │ └── main.yml
137-
│ │ └── test_integration.py
138-
│ └── unit
139-
│ └── .keep
140-
└── .vscode
141-
└── extensions.json
142-
```
36+
Full documentation on how to use this, along with it's integration with VS Code Ansible Extension can be found in https://ansible.readthedocs.io/projects/creator/.
14337

144-
### Upcoming features
38+
## Upcoming features
14539

14640
- Scaffold Ansible plugins of your choice with the `create` action.
14741
Switch to the [create](https://github.com/ansible-community/ansible-creator/tree/create) branch and try it out!

0 commit comments

Comments
 (0)