ansible/hacking
2015-07-02 18:59:58 +00:00
..
templates minor docs reformat 2015-06-03 22:19:26 -04:00
authors.sh fixed x-bits in git 2013-06-16 22:22:16 -04:00
env-setup egg_info is now written directly to lib 2015-03-27 12:03:20 -05:00
env-setup.fish Merge pull request #7306 from abadger/feature/egg-info 2014-12-15 16:26:37 -05:00
get_library.py Allow hacking/env-setup module path to use config file library path 2014-02-12 12:06:57 +10:00
module_formatter.py Merge branch 'v2_final' into devel_switch_v2 2015-05-28 15:26:03 -05:00
README.md fix path in Test-module example 2015-03-05 20:30:00 -05:00
test-module hacking/test-module: Style nit 2015-07-02 18:59:58 +00:00
update.sh Move update.sh to hacking repository ,see #10081 2015-01-30 14:19:47 +08:00

'Hacking' directory tools

Env-setup

The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python 2.6+. (You may not use python 3 at this time).

First, set up your environment to run from the checkout:

$ source ./hacking/env-setup

You will need some basic prerequisites installed. If you do not already have them and do not wish to install them from your operating system package manager, you can install them from pip

$ easy_install pip               # if pip is not already available
$ pip install pyyaml jinja2 nose passlib pycrypto

From there, follow ansible instructions on docs.ansible.com as normal.

Test-module

'test-module' is a simple program that allows module developers (or testers) to run a module outside of the ansible program, locally, on the current machine.

Example:

$ ./hacking/test-module -m lib/ansible/modules/core/commands/shell -a "echo hi"

This is a good way to insert a breakpoint into a module, for instance.

Module-formatter

The module formatter is a script used to generate manpages and online module documentation. This is used by the system makefiles and rarely needs to be run directly.

Authors

'authors' is a simple script that generates a list of everyone who has contributed code to the ansible repository.