ocflib is a Python library for working with Open Computing Facility services (in particular, accounts and server management).

The library targets Python 3.2 and 3.4 (the versions available in Debian wheezy and jessie). Python 2.7 compatibility is a plus but not required or tested.

The goal of the library is to make it easier to re-use OCF python code. In the past, code was split between approve, atool, create, chpass, sorry, signat, etc., which made it difficult to do things like share common password requirements.

In general, code which can be re-used should be here, but standalone applications or binaries shouldn't. For example, atool uses ocflib code to change passwords and create accounts, but the Django web app doesn't belong here.

ocflib is installed by Puppet on the OCF, so you can simply do things like import ocflib.constants from the system python3 installation. We don't install it to python2 site-packages.

We build a Debian package which is installed by Puppet. We also publish new versions to PyPI, which is useful because it allows easy installation into virtualenvs.

The easiest way to test changes to ocflib is to create a virtualenv and install ocflib in development mode:

virtualenv -p $(which python3) ~/venv/ocflib
. ~/venv/ocflib/bin/activate
pip install -r requirements-dev.txt
pip install -e .

Now, if you import something from ocflib, you'll be using the version from your working copy.

We use pytest to test our code, and flake8 to lint it. You should run make check before pushing to run both.

The tests directory contains automated tests which you're encouraged to add to (and not break). The tests-manual directory contains scripts intended for testing.

Ideally, you should test your changes in a clean virtualenv (not the one you develop in). To do this, just run make tox. This will create a clean virtualenv, install ocflib inside of it, and then run the tests.

Normally, it is sufficient to just run make check from your development environment, then push your changes. Jenkins will run the tests in the sandbox and catch any unexpected failures.

Deploying changes involves:

• Running tests and linters
• Pushing a new version to PyPI
• Building a Debian package
• Pushing the Debian package to our internal apt

Jenkins will automatically perform all of these steps for you on every push, including automatically generating a new version number. As long as make tox passes, your code will be automatically deployed. You can monitor the progress of your deploy here.