A twisted-based Juju client.
Project description
txjuju provides twisted-based tools for interacting with Juju. This includes both an API client and a CLI wrapper. The library is limited to Python 2, but does support both Juju 1.x and 2.x. Support for Python 3 is on the radar.
Note that only a portion of Juju’s capability is exposed in txjuju. This is because the code originates in the Landscape project and did not grow much beyond the needs of Landscape. The official Python bindings for Juju (python-libjuju) will usually offer a better experience. At some point python-libjuju may entirely supercede txjuju.
Key Components
Here are the essential classes of txjuju:
Additionally, txjuju.prepare_for_bootstrap() is especially useful.
For more information see DOC.rst.
Example Usage
API Client
from twisted.internet import reactor
from twisted.internet.defer import inlineCallbacks
from txjuju.api import Endpoint
endpoint = Endpoint(reactor, "ec2-1-2-3-4.compute-1.amazonaws.com")
deferred = endpoint.connect()
@inlineCallbacks
def connected(client):
yield client.login("user-admin", "54830489236383334d1d9fd84adae72c")
yield client.setAnnotations("unit", "1", {"foo": "bar"})
deferred.addCallback(connected)
reactor.run()
CLI Wrapper
import pprint
from twisted.internet import reactor
from twisted.internet.defer import inlineCallbacks, returnValue
from txjuju import prepare_for_bootstrap
from txjuju.cli import BootstrapSpec, Juju1CLI
cfgdir = "/tmp/my-juju"
spec = BootstrapSpec("my-env", "lxd")
cli = Juju1CLI(cfgdir)
@inlineCallbacks
def bootstrap():
prepare_for_bootstrap(spec, "1.25.6", cfgdir)
yield cli.boostrap(spec.name, "0")
raw = yield cli.api_info(spec.name)
returnValue(raw)
deferred = bootstrap()
deferred.addCallback(lambda v: pprint.pprint(v))
reactor.run()
Contributing
If you’d like to contribute to txjuju, feel free to open an issue or send us a pull request. As far as borrowing from txjuju goes, the code is LGPLv3-licensed.
Packaging
A Python package may be created using python2 setup.py sdist. For building a debian package see BUILD and build.sh.
Style
The txjuju code follows PEP 8. It is a good idea to frequently run something like flake8 when making changes. Other txjuju-specific guidelines:
use double quotes for strings
test methods should have docstrings
Testing
To run the test suite, run make test or python2 -m unittest txjuju.tests.test_XXX.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file txjuju-0.9.0a1.tar.gz
.
File metadata
- Download URL: txjuju-0.9.0a1.tar.gz
- Upload date:
- Size: 39.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc2501709189b99ef3dbe9c528135f3ab079de5d7af4b671087fb7f156a7bc04 |
|
MD5 | 5f37613a8fab93806098bb830ab83e55 |
|
BLAKE2b-256 | 06d4b17dc04c721d9633b295bc71a9aec0ab37325bf1b6a5694e9b0908bd3154 |