Skip to main content

Craft parts tooling

Project description

# Craft Parts

[![Documentation Status](https://readthedocs.com/projects/canonical-craft-parts/badge/?version=latest)](https://canonical-craft-parts.readthedocs-hosted.com/en/latest/?badge=latest)

Craft-parts provides a mechanism to obtain data from different sources, process it in various ways, and prepare a filesystem subtree suitable for deployment. The components used in its project specification are called parts, which can be independently downloaded, built and installed, and also depend on each other in order to assemble the subtree containing the final artifacts.

# License

Free software: GNU Lesser General Public License v3

# Documentation

https://canonical-craft-parts.readthedocs-hosted.com/en/latest/

# Contributing

A Makefile is provided for easy interaction with the project. To see all available options run:

` make help `

## Development Environment

In order to develop any apt related items, the python-apt package is needed. The apt extra will require this package in general.

Apt package prerequisites for this development environment on an Ubuntu system can be installed with:

`bash sudo apt install libapt-pkg-dev intltool fuse-overlayfs `

On a Debian or Ubuntu system, the appropriate package can be installed by running

`bash apt source python-apt pip install ./python-apt_* `

or by downloading and installing the appropriate source tarball. On Ubuntu these are:

## Running tests

To run all tests in the suite run:

` make tests `

## Adding new requirements

If a new dependency is added to the project run:

` make freeze-requirements `

## Verifying documentation changes

To locally verify documentation changes run:

` make docs `

After running, newly generated documentation shall be available at ./docs/_build/html/.

## Committing code

Please follow these guidelines when committing code for this project:

  • Use a topic with a colon to start the subject

  • Separate subject from body with a blank line

  • Limit the subject line to 50 characters

  • Do not capitalize the subject line

  • Do not end the subject line with a period

  • Use the imperative mood in the subject line

  • Wrap the body at 72 characters

  • Use the body to explain what and why (instead of how)

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

craft_parts-1.33.0.tar.gz (335.3 kB view details)

Uploaded Source

Built Distribution

craft_parts-1.33.0-py3-none-any.whl (429.5 kB view details)

Uploaded Python 3

File details

Details for the file craft_parts-1.33.0.tar.gz.

File metadata

  • Download URL: craft_parts-1.33.0.tar.gz
  • Upload date:
  • Size: 335.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for craft_parts-1.33.0.tar.gz
Algorithm Hash digest
SHA256 cb07fbfc46f44c4a7fce641baaf1d4476bb835858ac10069a9407921743427f5
MD5 95a096e31afe89059e1ab87cf3441bdc
BLAKE2b-256 7c2d5a2cd895c8bfebfb35b948345c4224e740e17901eecdc4833821146a8da5

See more details on using hashes here.

File details

Details for the file craft_parts-1.33.0-py3-none-any.whl.

File metadata

  • Download URL: craft_parts-1.33.0-py3-none-any.whl
  • Upload date:
  • Size: 429.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for craft_parts-1.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3179d03673b649a43432714dd7fb7d2d30fec26b5d052553f76232cafc64e7a4
MD5 60cdcdfc5e7cadc37c0daceb3e3f2860
BLAKE2b-256 e2416246ad51a4fe3dd3ebe64a9d600f0a31ad46b0af496452ca4d439c43a15b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page