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.30.1.tar.gz (326.0 kB view details)

Uploaded Source

Built Distribution

craft_parts-1.30.1-py3-none-any.whl (410.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: craft_parts-1.30.1.tar.gz
  • Upload date:
  • Size: 326.0 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.30.1.tar.gz
Algorithm Hash digest
SHA256 9042f00444193b7df417cff414842807eea676ede6fab98f8a4f2c72ed5a4a4f
MD5 7daeb4661270b79ebba98b039740547d
BLAKE2b-256 6ab48da6c97529838475387367512d652584300c06143c7b50a97f290799d496

See more details on using hashes here.

File details

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

File metadata

  • Download URL: craft_parts-1.30.1-py3-none-any.whl
  • Upload date:
  • Size: 410.8 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.30.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed60315523e1f89f9cd0e123b5a93c406244a68bd52111da7c93144ea5e899e1
MD5 f6b9d2c3e131e011cd2b222ed8098243
BLAKE2b-256 893858eb173b795a9f2f05f4f0fb6ad62046bae00e0c67d1d91bf1990a02a7c3

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