Charmcraft

Charmcraft Documentation Status Tests Spread Weekly Spread

Charmcraft is the command-line tool for initializing, packaging, and publishing charms, the software operators used by Juju. With Charmcraft, you can bypass the boilerplate steps of crafting a charm and focus on what matters — building scalable, configurable, and easy-to-deploy applications for Juju.

Basic usage

Charmcraft provides commands to streamline every step of the charm development process, from initializing your charm project to releasing it on Charmhub.

In your project's root directory, initialize your charm project with basic template content by running:

charmcraft init

Once you've configured your project to suit the needs of the application you're charming, build the charm by running:

charmcraft pack

If you're ready to distribute your charm, you can register its name on Charmhub with:

charmcraft register

Upload your charm and any subsequent revisions to Charmhub with:

charmcraft upload

Installation

Charmcraft is available on all major Linux distributions and macOS.

The recommended way to install Charmcraft on Linux systems is through its snap.

sudo snap install charmcraft --classic

For information on installing Charmcraft on other platforms, refer to our installation guide.

Documentation

The Charmcraft documentation provides guidance and learning materials for every step of the charming process. Whether you're new to charming or a seasoned expert, this is the best place to deepen your knowledge.

Community and support

To get in touch with developers and other charmcraft-badge: https://snapcraft.io/charmcraft/badge.svg charmcraft-site: https://snapcraft.io/charmcraft members of the charming community, reach out on the forum or in our Matrix channel.

You can report any issues or bugs on the project's GitHub repository.

Charmcraft is covered by the Ubuntu Code of Conduct.

Contribute to Charmcraft

Charmcraft is open source and part of the Canonical family. We would love your help.

If you're interested, start with the contribution guide.

We welcome any suggestions and help with the docs. The Canonical Open Documentation Academy is the hub for doc development, including Charmcraft docs. No prior coding experience is required.

License and copyright

Charmcraft is released under the Apache-2.0 license

© 2023-2025 Canonical Ltd.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (4.4.2)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for cmatsuoka from gravatar.com cmatsuoka Avatar for lengau from gravatar.com lengau Avatar for steinbro from gravatar.com steinbro

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Classifiers

Report project as malware

Download files

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

Source Distribution

charmcraft-4.4.1.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

charmcraft-4.4.1-py3-none-any.whl (301.8 kB view details)

Uploaded Python 3

File details

Details for the file charmcraft-4.4.1.tar.gz.

File metadata

  • Download URL: charmcraft-4.4.1.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for charmcraft-4.4.1.tar.gz
Algorithm Hash digest
SHA256 00228ffeaea667f7b775beb5a222606585150f1387d5edcdac108ac77b2a07fe
MD5 7aebce4e3be6ad878da1929e8ace82fa
BLAKE2b-256 bc14ed6f26a4418998c9c50d0a3439c12def5b96c4c024f94b2164c76556149c

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmcraft-4.4.1.tar.gz:

Publisher: release-publish.yaml on canonical/charmcraft

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file charmcraft-4.4.1-py3-none-any.whl.

File metadata

  • Download URL: charmcraft-4.4.1-py3-none-any.whl
  • Upload date:
  • Size: 301.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for charmcraft-4.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e7c72b26106e737862732ab2491ba65f7d2041a224f32446243a22d08e4027df
MD5 f841c6be6989b85b2a289c961d2971cb
BLAKE2b-256 d177c38cb172bf982dc255f504c465a53175728cb05b873d6e22ecc9d593c8f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for charmcraft-4.4.1-py3-none-any.whl:

Publisher: release-publish.yaml on canonical/charmcraft

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

4.4.2

2 files

This release

4.4.1 This release

2 files

4.4.0

2 files

4.3.1

2 files

4.3.0

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.0

2 files

4.0.1

2 files

4.0.0

2 files

3.5.3

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.3

2 files

3.4.2

2 files

3.4.1

2 files

3.3.3

2 files

3.3.2

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.7.4

2 files

2.7.3

2 files

2.7.2

1 file

2.7.1

2 files

2.7.0

2 files

2.6.0

2 files

2.5.5

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

1 file

2.5.1

1 file

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.7.1

2 files

1.7.0

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.1

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

1 file

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page