juju · PyPI

Source code: https://github.com/juju/python-libjuju

Bug reports: https://github.com/juju/python-libjuju/issues

Documentation: https://pythonlibjuju.readthedocs.io/en/latest/

Supported Python versions: 3.8 through 3.13 Supported Juju versions: 3.1 through 3.6

Design Notes

Asynchronous - Uses asyncio and async/await features of Python
Websocket-level bindings are programmatically generated (indirectly) from the Juju golang code, ensuring full api coverage
Provides an OO layer which encapsulates much of the websocket api and provides familiar nouns and verbs (e.g. Model.deploy(), Application.add_unit(), etc.)

Installation

pip3 install juju

Quickstart

Here’s a simple example that shows basic usage of the library. The example connects to the currently active Juju model, deploys a single unit of the ubuntu charm, then exits:

Note : Pylibjuju requires an already bootstrapped Juju controller to connect to.

#!/usr/bin/python3

import asyncio
import logging
import sys

from juju.model import Model


async def deploy():
    # Create a Model instance. We need to connect our Model to a Juju api
    # server before we can use it.
    model = Model()

    # Connect to the currently active Juju model
    await model.connect()

    try:
        # Deploy a single unit of the ubuntu charm, using the latest revision
        # from the stable channel of the Charm Store.
        ubuntu_app = await model.deploy(
          'ubuntu',
          application_name='my-ubuntu',
        )

        if '--wait' in sys.argv:
            # optionally block until the application is ready
            await model.wait_for_idle(status='active')

    finally:
        # Disconnect from the api server and cleanup.
        await model.disconnect()


def main():
    logging.basicConfig(level=logging.INFO)

    # If you want to see everything sent over the wire, set this to DEBUG.
    ws_logger = logging.getLogger('websockets.protocol')
    ws_logger.setLevel(logging.INFO)

    # Run the deploy coroutine in an asyncio event loop, using a helper
    # that abstracts loop creation and teardown.
    asyncio.run(deploy())


if __name__ == '__main__':
    main()

More examples can be found in the docs, as well as in the examples/ directory of the source tree which can be run using tox. For example, to run examples/connect_current_model.py, use:

tox -e example -- examples/connect_current_model.py

REPL

To experiment with the library in a REPL, launch python in asyncio mode

$ python3 -m asyncio

and then, to connect to the current model and fetch status:

>>> from juju.model import Model
>>> model = Model()
>>> await model.connect_current()
>>> status = await model.get_status()

Versioning

The current Pylibjuju release policy tracks the Juju release cadence. In particular, whenever Juju makes a latest/stable release, pylibjuju pushes out a release with the same version in the following week. Newly generated schemas will be updated per Juju releases.

Metadata

Release files for juju 3.6.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for juju 3.6.1.1
File	Size	Uploaded
juju-3.6.1.1.tar.gz	305.1 kB	Mar 19, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for juju 3.6.1.1
File	Interpreter	ABI	Platform	Reset
juju-3.6.1.1-py3-none-any.whl 287.1 kB Mar 19, 2025	Python 3	none	any	Details

Total release size: 592.2 kB

Release files / juju-3.6.1.1.tar.gz

Download URL	juju-3.6.1.1.tar.gz
Size	305.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`2289abd450515b7883f12f06d42f965d31939e711c496cb8713b4b058408e589`
BLAKE2b-256 checksum How to use checksums	`66320816544d9997f66a48a5cd3e799d5f07687da1dc9b5234d44389cbd7b4fc`
Upload date	Mar 19, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.0`

Release files / juju-3.6.1.1-py3-none-any.whl

Download URL	juju-3.6.1.1-py3-none-any.whl
Size	287.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`19ede730130b03cd5a99850f812521c2eb93199771207b50e1edf86e5e47acb2`
BLAKE2b-256 checksum How to use checksums	`9ea0b3e6e6b79409e384627a79636cd012dd03b5ae103669a868147faf9cd830`
Upload date	Mar 19, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.0`