use a Makefile to build and test this project

.gitignore

@@ -1,2 +1,56 @@
+# ansible module file
+library/
+
+# test files
+test/ansible/data/kube-manager-test.yaml
+test/ansible/data/kube-manager-test.yaml.orig
+test/ansible/data/noexist*
+test/ansible/data/foo.yml
+test/ansible/data/foo.yml.orig
+
 # VIM tmp files
 *.swp
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# virtualenv
+.venv
+venv/
+ENV/

Makefile

@@ -0,0 +1,22 @@
+ANSIBLE_MODULE_FILE=library/yedit.py
+
+
+all: ansible test
+
+
+test: test-style test-unit test-ansible
+
+test-style:
+	pylint yedit
+
+test-unit:
+	PYTHONPATH=. python test/units.py
+
+test-ansible:
+	ANSIBLE_STDOUT_CALLBACK=actionable ansible-playbook test/ansible/*.yml
+
+ansible:
+	stickytape yedit/__main__.py > $(ANSIBLE_MODULE_FILE)
+
+clean:
+	rm -f $(ANSIBLE_MODULE_FILE)

README.adoc

@@ -16,12 +16,37 @@ I didn't see a good method of editing yaml files and config managing them throug
 == Directory Structure
 
 ----
-yedit
-├── roles                Contains the ansible role for lib_yaml_editor
-├── test                 python unit tests for yedit
+yedit/
+├── yedit/
+│   ├── __init__.py
+│   ├── __main__.py      ansible module
+│   ├── yedit.py         the actual python code, which does the heavy lifting
+├── test/
+│   ├── ansible/         integration tests as ansible playbooks
+│   └── units.py         unit tests for the yedit class
+├── library/             target directory for ansible module
 ----
 
-== Examples:
+== Usage
+
+To use this module with ansible create the module file first:
+
+```
+$ make ansible
+$ file library/yedit.py
+library/yedit.py: Python script, ASCII text executable
+```
+
+The resulting file can be copied or symlinked into your project.
+
+== Development
+
+1. install dependencies: `pip install -r requirements.txt`
+2. make your changes in `yedit/*.py`
+3. run `make` to build and test your changes
+4. commit them and send us a PR :)
+
+== Examples
 
 Sometimes it is necesarry to config manage .yml files.
 [source,yaml]

pylintrc

@@ -0,0 +1,6 @@
+[MESSAGES CONTROL]
+disable=locally-disabled,missing-docstring
+
+[FORMAT]
+max-line-length=119
+

requirements.txt

@@ -0,0 +1,4 @@
+pyyaml
+ansible
+stickytape
+pylint