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 v6 as ops_config
from opscripts.logging import v2 as ops_logging
from opscripts.utils import v8 as ops_utils

For a more in-depth examples, see the:

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

Dependencies

• opscripts.config
  • ConfigArgParse
  • PyYAML
• opscripts.yaml
  • ordereddict (only required by Python 2.6)
  • PyYAML
• Unit Tests
  • mock (only required by Python < 3.3)
  • pytest
  • pytest-catchlog
  • pytest-colordots
  • pytest-flakes
  • pytest-localserver
  • pytest-pep8
  • pytest-pep257
  • pytest-pythonpath
  • pytest-remove-stale-bytecode
  • pytest-warnings

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
   

   1. If installing requirements errors, update pip:

      pip install --upgrade pip
      

   2. Install requirements:

      pip install -r tests/requirements.txt
      

3. Run pytest:

   py.test
   

To test against alternate Python versions, it may be useful to create virtual environments with an interpreter other than the one with which virtualenv was installed, e.g. for non-default python3:

mkvirtualenv -a . -p $(which python3) -r tests/requirements.txt \
    opscripts_test3

License

• LICENSE (MIT License)