Skip to content

ohmu/poni

Repository files navigation

Poni readme

Overview

Poni is a simple system configuration management tool implemented in Python.

General Information

documentation:http://melor.github.com/poni/
source repo:https://github.com/melor/poni
pypi:http://pypi.python.org/pypi/poni
email:mika dot eloranta at gmail dot com
bug tracker:https://github.com/melor/poni/issues
build status:BuildStatus

Pre-requisites

Installing and operating Poni requires:

  • Python 2.6, 2.7 or 3.4 or greater
  • setuptools installed
  • Internet connection for downloading the dependency Python packages from PyPI

Using Amazon EC2 requires setting the following environment variables:

export AWS_ACCESS_KEY_ID=<your aws access key>
export AWS_SECRET_ACCESS_KEY=<your aws secret access key>

Additionally, running the included automated tests requires:

Building HTML files from the included ReST documentation requires:

Installation

NOTE: during installation the following package and its dependencies are automatically installed from PyPI:

  • Argh (command-line argument parsing)

Installing the following Python libraries will add optional functionality:

  • Cheetah (text-based templating language)
  • Genshi (XML-based templating language)
  • Mako (text-based templating language)
  • Paramiko (Remote node control using SSH)
  • GitPython (Version controlling the repository with Git)
  • Boto (Amazon EC2 virtual machine provisioning)
  • pyvsphere (VMWare virtual machine provisioning)
  • libvirt-python (libvirt virtual machine provisioning)
  • lxml (libvirt provisioning dependency)
  • dnspython (libvirt provisioning dependency)
  • PyDNS (used if dnspython isn't available)

Installation using pip or easy_install

Poni can be installed from Python Package Index (PyPI) by running pip install poni or easy_install poni.

Manual Installation steps

  1. Unpack the poni-v.vv.tar.gz package
  2. cd poni-v.vv/
  3. python setup.py install

Verifying the installation

  • You should be able to import poni from Python
  • The poni command-line tool is installed (to a platform-specific location), try running poni -h for help
  • Running automated tests: make tests

Usage

Please refer to the documentation under the doc/ directory (published at http://melor.github.com/poni/) and to the example systems under the examples/ directory.

Credits

Thanks for the contributions!

  • Oskari Saarenmaa (features)
  • Santeri Paavolainen (fixes)
  • Lakshmi Vyas (new features for AWS-EC2 support)
  • Lauri Heiskanen (enabling pseudo-tty)
  • F-Secure Corporation (major improvements, VMWare vSphere and libvirt support)

License (Apache 2.0)

This package is licensed under the open-source "Apache License, Version 2.0".

The full license text is available in the file LICENSE and at http://www.apache.org/licenses/LICENSE-2.0.txt

Note: poni versions older than 0.6 were licensed under the MIT license.