Jubilant

Jubilant is a Python library that wraps the Juju CLI for use in charm integration tests. It provides methods that map 1:1 to Juju CLI commands, but with a type-annotated, Pythonic interface.

You should consider switching to Jubilant if your integration tests currently use pytest-operator (and they probably do). Jubilant has an API you’ll pick up quickly, and it avoids some of the pain points of python-libjuju, such as websocket failures and having to use async. Read our design goals.

Jubilant is currently in pre-release or “beta” phase (see PyPI releases). Our intention is to release version 1.0.0 in May 2025.

The library provides:

• The main jubilant.Juju class, with methods such as deploy and integrate

• The Juju.wait method, which waits for a condition such as “all apps active”

• Status helpers such as jubilant.all_active, for use with Juju.wait

• Context managers such as jubilant.temp_model, for use in test setup and teardown

In this documentation

Tutorial

Start here: a hands-on introduction to Jubilant, including how to write a charm integration test

How-to guides

Step-by-step guides covering key operations and common tasks

Reference

Technical information

• API reference

Explanation

Discussion and clarification of key topics

• Design goals

Releases

Jubilant releases are tracked on GitHub, and use semantic versioning. To get notified when there’s a new release, watch the Jubilant repository.

Project and community

Jubilant is free software and released under the Apache license, version 2.0.

The Jubilant project is sponsored by Canonical Ltd.

• Code of conduct

• Contribute to the project

• Development: how to make changes to Jubilant and run its tests