Skip to main content

A module for working with Cloud Native Application Bundles in Python

Project description

Python CNAB Library

Work-in-progress library for working with CNAB in Python.

There are probably three main areas of interest for a CNAB client:

  1. Handling the bundle.json format (101)
  2. Building invocation images (102)
  3. Running actions against a CNAB (103)

Claims and Signing are optional but will be worked on once the above are stable.


The module is published on PyPi and can be installed from there.

pip install cnab

Parsing bundle.json

Nothing too fancy here, the Bundle class has a from_dict static method which builds a full Bundle object.

import json
from cnab import Bundle

with open("bundle.json") as f:
    data = json.load(f)

bundle = Bundle.from_dict(data)

This could for example be used for validation purposes, or for building user interfaces for bundle.json files.

Describing bundle.json in Python

You can also describe the bundle.json file in Python. This will correctly validate the structure based on the current specification and would allow for building a custom DSL or other user interface for generating bundle.json files.

from cnab import Bundle, InvocationImage

bundle = Bundle(


Running CNABs

The module supports running actions on a CNAB, using the docker driver.

from cnab import CNAB

# The first argument can be a path to a bundle.json file, a dictionary
# or a full `Bundle` object
app = CNAB("fixtures/helloworld/bundle.json")

# list available actions

# list available parameters

# run the install action

# run the install action specifying a parameters
print("install", parameters={"port": 9090}))

# Many applications will require credentials
app = CNAB("fixtures/hellohelm/bundle.json")

# list required credentials

# Here we pass the value for the required credential
# in this case by reading the existing configuration from disk
with open("/home/garethr/.kube/config") as f:
    print("status", credentials={"kubeconfig":}))

Note that error handling for this is very work-in-progress.

Working with invocation images

pycnab also has a class for working with invocation images.

from cnab import CNABDirectory

directory = CNABDirectory("fixtures/invocationimage")

# Check whether the directory is valid
# Raises `InvalidCNABDirectory` exception if invalid

# Returns the text of the associated README file if present

# Returns the text of the associated LICENSE file if present


Thanks to QuickType for bootstrapping the creation of the Python code for manipulating bundle.json based on the current JSON Schema.

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 cnab, version 0.1.7
Filename, size File type Python version Upload date Hashes
Filename, size cnab-0.1.7-py3-none-any.whl (37.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cnab-0.1.7.tar.gz (10.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page