README.rst

OpScripts

Python libraries to assist with writing Linux Ops scripts.

Python Compatibility

This library currently requires compatibility with:

• 2.6
• 2.7
• 3.4

However, additional versions are tested automatically:

API Versioning

Each module is versioned so that they can undergo significant changes without impacting the function and stability of the scripts that use them.

For example:

from opscripts.config import v5 as ops_config
from opscripts.logging import v2 as ops_logging
from opscripts.utils import v4 as ops_utils

For a more in-depth examples, see the:

• example.py
• example_notify_email.py
• example_yaml.py

Dependencies

• opscripts.config
  • ConfigArgParse
• opscripts.yaml
  • PyYAML
  • ordereddict (only required by Python 2.6)
• Unit Tests
  • pytest
  • pytest-catchlog
  • pytest-cov
  • pytest-flakes
  • pytest-localserver
  • pytest-pep8
  • pytest-pythonpath

Testing Quick Start

1. Change directory into repository (into same directory as where this README resides).

2. Install virtual environment:

   mkvirtualenv -a . -r tests/requirements.txt opscripts_test
   

3. Run pytest:

   py.test
   

License

• LICENSE (MIT License)