Skip to content

Commit

Permalink
Assorted README updates (#57)
Browse files Browse the repository at this point in the history
Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>
  • Loading branch information
NilashishC committed Jan 2, 2024
1 parent 0e4addd commit 9829ca1
Showing 1 changed file with 6 additions and 112 deletions.
118 changes: 6 additions & 112 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[![codecov](https://codecov.io/github/ansible/ansible-creator/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-creator)
![PyPI - Status](https://img.shields.io/pypi/status/ansible-creator)
![PyPI - Version](https://img.shields.io/pypi/v/ansible-creator)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ansible-creator)
Expand All @@ -11,13 +12,11 @@ A CLI tool for scaffolding all your Ansible Content.

## Installation

```
```shell
$ pip install ansible-creator
```

## Usage

```
```shell
$ ansible-creator --help
usage: ansible-creator [-h] [--version] {init} ...

Expand All @@ -32,116 +31,11 @@ Commands:
init Initialize an Ansible Collection.
```

### Initialize an Ansible Collection skeleton with 'init'

```
$ ansible-creator init --help
usage: ansible-creator init [-h] [--na] [--lf LOG_FILE] [--ll {notset,debug,info,warning,error,critical}] [--la {true,false}] [--json] [-v]
[--init-path INIT_PATH] [--force]
collection
Creates the skeleton framework of an Ansible collection.
positional arguments:
collection The collection name in the format ``<namespace>.<collection>``.
optional arguments:
-h, --help show this help message and exit
--na, --no-ansi Disable the use of ANSI codes for terminal color.
--lf LOG_FILE, --log-file <file> LOG_FILE
Log file to write to.
--ll {notset,debug,info,warning,error,critical}, --log-level <level> {notset,debug,info,warning,error,critical}
Log level for file output.
--la {true,false}, --log-append <bool> {true,false}
Append to log file.
--json Output messages as JSON
-v, --verbose Give more Cli output. Option is additive, and can be used up to 3 times.
--init-path INIT_PATH
The path in which the skeleton collection will be created. The default is the current working directory.
--force Force re-initialize the specified directory as an Ansible collection.
```

```
$ ansible-creator init testns.testname --init-path $HOME/collections/ansible_collections
Note: collection testns.testname created at /home/ansible-dev/collections/ansible_collections
```

Running the above command generates an Ansible Collection with the following structure:
## Usage

```
$ tree -lla /home/ansible-dev/collections/ansible_collections
.
├── CHANGELOG.rst
├── changelogs
│ └── config.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING
├── docs
│ ├── docsite
│ │ └── links.yml
│ └── .keep
├── extensions
│ ├── eda
│ │ └── rulebooks
│ │ └── rulebook.yml
│ └── molecule
│ ├── integration_hello_world
│ │ └── molecule.yml
│ └── utils
│ ├── playbooks
│ │ ├── converge.yml
│ │ └── noop.yml
│ └── vars
│ └── vars.yml
├── galaxy.yml
├── .github
│ └── workflows
│ └── test.yml
├── .isort.cfg
├── LICENSE
├── MAINTAINERS
├── meta
│ └── runtime.yml
├── plugins
│ ├── action
│ │ └── __init__.py
│ ├── cache
│ │ └── __init__.py
│ ├── filter
│ │ ├── hello_world.py
│ │ └── __init__.py
│ ├── inventory
│ │ └── __init__.py
│ ├── modules
│ │ └── __init__.py
│ ├── module_utils
│ │ └── __init__.py
│ ├── plugin_utils
│ │ └── __init__.py
│ ├── sub_plugins
│ │ └── __init__.py
│ └── test
│ └── __init__.py
├── .pre-commit-config.yaml
├── .prettierignore
├── pyproject.toml
├── README.md
├── tests
│ ├── .gitignore
│ ├── integration
│ │ ├── __init__.py
│ │ ├── targets
│ │ │ └── hello_world
│ │ │ └── tasks
│ │ │ └── main.yml
│ │ └── test_integration.py
│ └── unit
│ └── .keep
└── .vscode
└── extensions.json
```
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/.

### Upcoming features
## Upcoming features

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

0 comments on commit 9829ca1

Please sign in to comment.