Skip to main content

A client API library specially for MAAS.

Project description

python-libmaas

Python client API library made especially for MAAS.

Build Status codecov.io

Installation

All the dependencies are declared in setup.py so this can be installed with pip. Python 3.5+ is required.

When working from trunk it can be helpful to use virtualenv:

$ virtualenv --python=python3 amc && source amc/bin/activate
$ pip install git+https://github.com/maas/python-libmaas.git
$ maas --help

Releases are periodically made to PyPI but, at least for now, it makes more sense to work directly from trunk.

Documentation

Documentation can be generated with make docs which publishes into the site directory. Recent documentation is also published to the MAAS Client Library & CLI documentation site.

Development

It's pretty easy to start hacking on python-libmaas:

$ git clone git@github.com:maas/python-libmaas.git
$ cd python-libmaas
$ make develop
$ make test

Installing IPython is generally a good idea too:

$ bin/pip install -UI IPython

Pull requests are welcome but authors need to sign the Canonical contributor license agreement before those PRs can be merged.

History & licence

In short: AGPLv3.

python-libmaas was begun by a core MAAS developer, Gavin Panella, on his own time, but is now maintained by the core MAAS team at Canonical. It is licensed under the GNU Affero GPLv3, the same as MAAS itself.

Some of the code in here has come from MAAS, upon which Canonical Ltd has the copyright. Gavin Panella licenses his parts under the AGPLv3, and MAAS is also under the AGPLv3, so everything should be good.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for python-libmaas, version 0.6.5
Filename, size File type Python version Upload date Hashes
Filename, size python_libmaas-0.6.5-py3-none-any.whl (140.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size python-libmaas-0.6.5.tar.gz (93.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page