# Craft Parts > This is the documentation for Craft Parts, a Python package to support a family of > tools that create standalone software packages for deployment on Linux-based systems. 2021-2026 ## Pages - [Craft Parts](https://documentation.ubuntu.com/craft-parts/latest/index.html.md): Craft Parts is a Python package that supports a family of tools creating standalone software packages for deployment on Linux-based systems. - [Using craft-parts from the command line](https://documentation.ubuntu.com/craft-parts/latest/how-to/cli_tool/index.html.md): Parts processing can be also executed directly from the command line - [How to document a plugin](https://documentation.ubuntu.com/craft-parts/latest/how-to/document-plugin/index.html.md): This document contains a template that should be used when documenting new - [How-to guides](https://documentation.ubuntu.com/craft-parts/latest/how-to/index.html.md): The practical, goal-oriented documentation for Craft Parts. These guides provide directions for completing tasks and solving problems with Craft Parts. - [How to create a plugin](https://documentation.ubuntu.com/craft-parts/latest/how-to/create_plugin/index.html.md): Plugins help to bring new tools and programming languages into Craft Parts. - [How to add a custom source type to an application](https://documentation.ubuntu.com/craft-parts/latest/how-to/source-handler/index.html.md): An application may need additional source types not included in craft-parts - [Using parts in a project file](https://documentation.ubuntu.com/craft-parts/latest/how-to/use_parts/index.html.md): When packing, [parts](https://documentation.ubuntu.com/craft-parts/latest//common/craft-parts/explan... - [Exceptions](https://documentation.ubuntu.com/craft-parts/latest/reference/exceptions/index.html.md): Exceptions are defined in three different modules in the [`craft_parts`](https://documentation.ubunt... - [Reference](https://documentation.ubuntu.com/craft-parts/latest/reference/index.html.md): The reference documentation for Craft Parts. These references describe the structure and function of the individual components in Craft Parts. - [Package reference](https://documentation.ubuntu.com/craft-parts/latest/reference/reference/index.html.md): * [craft_parts package](https://documentation.ubuntu.com/craft-parts/latest//reference/gen/craft_par... - [Project information](https://documentation.ubuntu.com/craft-parts/latest/reference/infos/index.html.md): Project parameters are provided to callback functions by passing an - [Lifecycle manager](https://documentation.ubuntu.com/craft-parts/latest/reference/lifecycle_manager/index.html.md): The lifecycle manager holds information about the parts specification - [Actions](https://documentation.ubuntu.com/craft-parts/latest/reference/actions/index.html.md): Actions are the execution units needed to move the project state to - [Changelog](https://documentation.ubuntu.com/craft-parts/latest/reference/changelog/index.html.md): See the features and bug fixes added in each release of Craft Parts. - [Plugins](https://documentation.ubuntu.com/craft-parts/latest/reference/plugins/index.html.md): Plugins are used to provide support for specific technologies during the parts - [Parts and Steps](https://documentation.ubuntu.com/craft-parts/latest/reference/parts_steps/index.html.md): Parts and steps define the lifecycle of a project, or in other words, how to process - [Tutorials](https://documentation.ubuntu.com/craft-parts/latest/tutorials/index.html.md): The tutorials for Craft Parts. These tutorials are guided lessons that help you develop skills by using Craft Parts. - [Adding parts processing to an application](https://documentation.ubuntu.com/craft-parts/latest/tutorials/examples/index.html.md): To add parts processing to an application, instantiate the - [Hello craft-parts](https://documentation.ubuntu.com/craft-parts/latest/tutorials/hello-craft-parts/index.html.md): In this tutorial, you will build a parts-based project from scratch, using only - [Explanation](https://documentation.ubuntu.com/craft-parts/latest/explanation/index.html.md): The explanatory documentation for Craft Parts. These explanations aid in understanding the concepts of parts and how they're processed. - [Implementation notes](https://documentation.ubuntu.com/craft-parts/latest/explanation/implementation/index.html.md): The implementation reflects the two main lifecycle processing operations. All - [About this documentation](https://documentation.ubuntu.com/craft-parts/latest/explanation/documentation/index.html.md): An explanation of the documentation system, process, and writing style and conventions in Craft Parts. - [Cryptographic technology in Craft Parts](https://documentation.ubuntu.com/craft-parts/latest/explanation/cryptography/index.html.md): Craft Parts uses cryptographic technologies to obtain and process data from remote - [craft_parts.plugins.jlink_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.jlink_plugin/index.html.md): The JLink plugin. - [craft_parts.state_manager.states module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.states/index.html.md): Helpers and definitions for lifecycle states. - [craft_parts.utils.partition_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.partition_utils/index.html.md): Unit tests for partition utilities. - [craft_parts.executor package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor/index.html.md): * [craft_parts.executor.collisions module](https://documentation.ubuntu.com/craft-parts/latest//refe... - [craft_parts.sources.git_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.git_source/index.html.md): Implement the git source handler. - [craft_parts.sources.checksum module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.checksum/index.html.md): Helpers to compute and verify file checksums. - [craft_parts.plugins.properties module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.properties/index.html.md): Definitions and helpers for plugin options. - [craft_parts.permissions module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.permissions/index.html.md): Specify and apply permissions and ownership to part-owned files. - [craft_parts.state_manager.pull_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.pull_state/index.html.md): State definitions for the pull step. - [craft_parts.utils.path_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.path_utils/index.html.md): Utility functions for paths. - [craft_parts.plugins.qmake_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.qmake_plugin/index.html.md): The qmake plugin. - [craft_parts.executor.errors module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.errors/index.html.md): Executor error definitions. - [craft_parts.plugins.dotnet_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.dotnet_plugin/index.html.md): The Dotnet plugin. - [craft_parts.packages.dnf module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.dnf/index.html.md): Support for files installed/updated through DNF. - [craft_parts.packages.deb_package module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.deb_package/index.html.md): Debian package representation. - [craft_parts.utils.npm_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.npm_utils/index.html.md): Utility functions for NPM plugin. - [craft_parts.packages.yum module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.yum/index.html.md): Support for files installed/updated through YUM. - [craft_parts.overlays.layers module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.layers/index.html.md): Layer management and helpers. - [craft_parts.overlays.overlay_fs module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.overlay_fs/index.html.md): Low level interface to OS overlayfs. - [craft_parts.state_manager.stage_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.stage_state/index.html.md): State definitions for the stage step. - [craft_parts.sources.sources module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.sources/index.html.md): Source handle utilities. - [craft_parts.state_manager.step_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.step_state/index.html.md): The step state preserves step execution context information. - [craft_parts.executor.organize module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.organize/index.html.md): Handle part files organization. - [craft_parts.state_manager.state_manager module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.state_manager/index.html.md): Part crafter step state management. - [craft_parts.constraints module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.constraints/index.html.md): Pydantic constraints for various items. - [craft_parts.steps module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.steps/index.html.md): Definitions and helpers to handle lifecycle steps. - [craft_parts.utils package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils/index.html.md): * [craft_parts.utils.maven package](https://documentation.ubuntu.com/craft-parts/latest//reference/g... - [craft_parts.utils.os_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.os_utils/index.html.md): Utilities related to the operating system. - [craft_parts.actions module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.actions/index.html.md): Definitions of lifecycle actions and action types. - [craft_parts.plugins.dump_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.dump_plugin/index.html.md): The dump plugin. - [craft_parts.plugins.cargo_use_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.cargo_use_plugin/index.html.md): The cargo-use plugin. - [craft_parts.plugins.uv_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.uv_plugin/index.html.md): The uv plugin. - [craft_parts.utils.maven.common module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.maven.common/index.html.md): Utilities for Maven projects and settings. - [craft_parts.infos module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.infos/index.html.md): Project, part and step information classes. - [craft_parts.executor.part_handler module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.part_handler/index.html.md): Definitions and helpers for part handlers. - [craft_parts.sequencer module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sequencer/index.html.md): Determine the sequence of lifecycle actions to be executed. - [craft_parts.plugins.go_use_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.go_use_plugin/index.html.md): The Go-use plugin. - [craft_parts.plugins.npm_use_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.npm_use_plugin/index.html.md): The npm-use plugin. - [craft_parts.plugins.go_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.go_plugin/index.html.md): The Go plugin. - [craft_parts.sources.errors module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.errors/index.html.md): Source handler error definitions. - [craft_parts.sources.sevenzip_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.sevenzip_source/index.html.md): Implement the 7zip file source handler. - [craft_parts.plugins.ant_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.ant_plugin/index.html.md): The Ant plugin. - [craft_parts.plugins.meson_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.meson_plugin/index.html.md): The Meson plugin. - [craft_parts.executor.migration module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.migration/index.html.md): Handle the execution of built-in or user specified step commands. - [craft_parts.plugins.ruby_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.ruby_plugin/index.html.md): The Ruby plugin. - [craft_parts.filesystem_mounts module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.filesystem_mounts/index.html.md): FilesystemMounts models. - [craft_parts.lifecycle_manager module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.lifecycle_manager/index.html.md): The parts lifecycle manager. - [craft_parts.packages.deb module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.deb/index.html.md): Support for deb files. - [craft_parts.sources.base module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.base/index.html.md): Base classes for source type handling. - [craft_parts.plugins.validator module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.validator/index.html.md): Definitions and helpers for plugin environment validation. - [craft_parts.packages.chisel module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.chisel/index.html.md): Support for Chisel operations. - [craft_parts.utils.maven package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.maven/index.html.md): * [craft_parts.utils.maven.common module](https://documentation.ubuntu.com/craft-parts/latest//refer... - [craft_parts.packages.apt_cache module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.apt_cache/index.html.md): Manages the state of packages obtained using apt. - [craft_parts.plugins.python_v2.python_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.python_v2.python_plugin/index.html.md): Version 2 of the Python plugin. - [craft_parts.plugins.base module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.base/index.html.md): Plugin base class and definitions. - [craft_parts.plugins.scons_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.scons_plugin/index.html.md): The SCons plugin. - [craft_parts.plugins.python_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.python_plugin/index.html.md): The python plugin. - [craft_parts.plugins.cmake_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.cmake_plugin/index.html.md): The cmake plugin. - [craft_parts.plugins.maven_use_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.maven_use_plugin/index.html.md): The maven-use plugin. - [craft_parts.errors module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.errors/index.html.md): Craft parts errors. - [craft_parts.overlays.overlay_manager module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.overlay_manager/index.html.md): Overlay mount operations and package installation helpers. - [craft_parts.state_manager.overlay_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.overlay_state/index.html.md): State definitions for the overlay step. - [craft_parts.executor.executor module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.executor/index.html.md): Definitions and helpers for the action executor. - [craft_parts.plugins.autotools_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.autotools_plugin/index.html.md): The autotools plugin implementation. - [craft_parts.sources.tar_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.tar_source/index.html.md): Implement the tar source handler. - [craft_parts.main module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.main/index.html.md): Part crafting command line tool. - [craft_parts.plugins.make_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.make_plugin/index.html.md): The make plugin implementation. - [craft_parts.callbacks module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.callbacks/index.html.md): Register and execute callback functions. - [craft_parts.dirs module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.dirs/index.html.md): Definitions for project directories. - [craft_parts.overlays package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays/index.html.md): * [craft_parts.overlays.chroot module](https://documentation.ubuntu.com/craft-parts/latest//referenc... - [craft_parts.executor.filesets module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.filesets/index.html.md): Definitions and helpers to handle filesets. - [craft_parts.utils.url_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.url_utils/index.html.md): URL parsing and downloading helpers. - [craft_parts.state_manager package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager/index.html.md): * [craft_parts.state_manager.build_state module](https://documentation.ubuntu.com/craft-parts/latest... - [craft_parts.plugins.colcon_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.colcon_plugin/index.html.md): The colcon plugin implementation. - [craft_parts.sources.local_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.local_source/index.html.md): The local source handler and helpers. - [craft_parts.xattrs module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.xattrs/index.html.md): Helpers to read and write filesystem extended attributes. - [craft_parts.sources.snap_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.snap_source/index.html.md): The snap source handler. - [craft_parts.parts module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.parts/index.html.md): Definitions and helpers to handle parts. - [craft_parts.plugins package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins/index.html.md): * [craft_parts.plugins.python_v2 package](https://documentation.ubuntu.com/craft-parts/latest//refer... - [craft_parts.sources.rpm_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.rpm_source/index.html.md): The RPM source handler. - [craft_parts.plugins.plugins module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.plugins/index.html.md): Definitions and helpers to handle plugins. - [craft_parts.plugins.nil_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.nil_plugin/index.html.md): The nil plugin. - [craft_parts.overlays.chroot module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.chroot/index.html.md): Execute a callable in a chroot environment. - [craft_parts.features module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.features/index.html.md): Global features to be configured by the application. - [craft_parts.executor.environment module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.environment/index.html.md): Helpers to handle part environment setting. - [craft_parts.executor.step_handler module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.step_handler/index.html.md): Handle the execution of built-in or user specified step commands. - [craft_parts.plugins.gradle_use_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.gradle_use_plugin/index.html.md): The gradle-use plugin. - [craft_parts.packages.errors module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.errors/index.html.md): Exceptions raised by the packages handling subsystem. - [craft_parts.packages.base module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.base/index.html.md): Definition and helpers for the repository base class. - [craft_parts.overlays.overlays module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.overlays/index.html.md): Overlay handling helpers. - [craft_parts.utils.process module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.process/index.html.md): Utilities for executing subprocesses and handling their stdout and stderr streams. - [craft_parts.utils.deb_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.deb_utils/index.html.md): deb-related utilities used by both packages and sources. - [craft_parts.plugins.dotnet_v2_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.dotnet_v2_plugin/index.html.md): The new .NET plugin. - [craft_parts.utils.gradle_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.gradle_utils/index.html.md): Groovy templates for Gradle init scripts. - [craft_parts.sources.deb_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.deb_source/index.html.md): The deb source handler. - [craft_parts.plugins.python_v2 package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.python_v2/index.html.md): * [craft_parts.plugins.python_v2.python_plugin module](https://documentation.ubuntu.com/craft-parts/... - [craft_parts.plugins.gradle_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.gradle_plugin/index.html.md): The gradle plugin. - [craft_parts.overlays.errors module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.overlays.errors/index.html.md): Overlay error definitions. - [craft_parts.utils.git module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.git/index.html.md): Helpers to use git. - [craft_parts.packages.normalize module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.normalize/index.html.md): Definition and helpers for the repository base class. - [craft_parts.utils.file_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.file_utils/index.html.md): File-related utilities. - [craft_parts.packages.snaps module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.snaps/index.html.md): Helpers to install snap packages. - [craft_parts.sources package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources/index.html.md): * [craft_parts.sources.base module](https://documentation.ubuntu.com/craft-parts/latest//reference/g... - [craft_parts.executor.collisions module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.executor.collisions/index.html.md): Helpers to detect conflicting staging files from multiple parts. - [craft_parts.plugins.rust_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.rust_plugin/index.html.md): The craft Rust plugin. - [craft_parts.ctl module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.ctl/index.html.md): Helpers to invoke step execution handlers from the command line. - [craft_parts.packages.platform module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages.platform/index.html.md): Helpers to determine the repository for the platform. - [craft_parts.state_manager.build_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.build_state/index.html.md): State definitions for the build step. - [craft_parts.utils.formatting_utils module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.utils.formatting_utils/index.html.md): Text formatting utilities. - [craft_parts.state_manager.prime_state module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.prime_state/index.html.md): State definitions for the prime state. - [craft_parts.sources.cache module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.cache/index.html.md): Cache base and file cache. - [craft_parts package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts/index.html.md): * [craft_parts.executor package](https://documentation.ubuntu.com/craft-parts/latest//reference/gen/... - [craft_parts.plugins.bazel_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.bazel_plugin/index.html.md): The Bazel plugin implementation. - [craft_parts.plugins.maven_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.maven_plugin/index.html.md): The maven plugin. - [craft_parts.state_manager.reports module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.state_manager.reports/index.html.md): Provide a report on why a step is outdated. - [craft_parts.sources.file_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.file_source/index.html.md): Implement the plain file source handler. - [craft_parts.plugins.java_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.java_plugin/index.html.md): Plugin base class and definitions. - [craft_parts.plugins.poetry_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.poetry_plugin/index.html.md): The poetry plugin. - [craft_parts.pydantic_schema module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.pydantic_schema/index.html.md): Experiments with pydantic schemas. - [craft_parts.packages package](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.packages/index.html.md): * [craft_parts.packages.apt_cache module](https://documentation.ubuntu.com/craft-parts/latest//refer... - [craft_parts.plugins.npm_plugin module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.plugins.npm_plugin/index.html.md): The npm plugin. - [craft_parts.sources.zip_source module](https://documentation.ubuntu.com/craft-parts/latest/reference/gen/craft_parts.sources.zip_source/index.html.md): Implement the zip file source handler. - [Customise the build with craftctl](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/how-to/customise-the-build-with-craftctl/index.html.md): Craft Parts ships with craftctl, a utility for executing steps in parts. When defining a part, - [Including local files and remote resources](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/how-to/include_files/index.html.md): The Dump plugin is handy for all kinds of projects that need to - [Override the default build](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/how-to/override_build/index.html.md): Craft Parts provides plugins for a number of different programming languages, frameworks, and - [Partition-specific output directory environment variables](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/partition_specific_output_directory_variables/index.html.md): If partitions are enabled, partition-specific environment variables will be created for - [Part properties](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/part_properties/index.html.md): This reference describes the purpose and usage of all keys that can be declared for - [Overlay step](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/overlays/index.html.md): Some Craft applications, such as [Rockcraft](https://documentation.ubuntu.com/rockcraft/stable/), in... - [Gradle Plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/gradle_plugin/index.html.md): Gradle plugin is a plugin that simplifies building and packaging Jars for projects that - [Filesets](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/filesets/index.html.md): Filesets are named collections of files and directories that can be migrated - [Parts](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/parts/index.html.md): A *part* is a description of the components to be built and prepared for deployment in a - [Lifecycle details](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/lifecycle/index.html.md): Each part is built in five separate steps, each with its own input and output locations: - [File migration](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/file-migration/index.html.md): During the part lifecycle, files resulting from building a part - [Dump Plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/explanation/dump_plugin/index.html.md): The dump plugin is a simple plugin that by default is equivalent to running the - [npm-use plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/npm_use_plugin/index.html.md): The npm-use plugin packages projects based on npm and, unlike the - [uv plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/uv_plugin/index.html.md): The uv plugin can be used for Python projects that use the uv build tool. - [Bazel plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/bazel_plugin/index.html.md): Reference for parts built with the Bazel plugin. Review the plugin's special configuration keys and see working examples of Bazel parts in YAML. - [Make plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/make_plugin/index.html.md): The Make plugin can be used with projects that use a `Makefile` to build with [GNU - [Gradle plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/gradle_plugin/index.html.md): The Gradle plugin builds Java projects using the Gradle build tool. - [Nil plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/nil_plugin/index.html.md): The Nil plugin can be used to by-pass the need for a plugin when only parts primitives - [Ant plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/ant_plugin/index.html.md): The Ant plugin builds Java projects using the [Apache Ant](https://ant.apache.org/) build tool. This... - [Maven plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/maven_plugin/index.html.md): Maven plugin is a plugin that simplifies building and packaging Jars for projects that - [Python plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/python_plugin/index.html.md): The Python plugin can be used for Python projects where you would want to do any of the - [Gradle-use plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/gradle_use_plugin/index.html.md): The Gradle-use plugin builds Java projects using the Gradle build tool and, unlike - [Maven-use plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/maven_use_plugin/index.html.md): The Maven-use plugin packages [Maven](https://maven.apache.org/index.html)-based projects and, unlik... - [Go-use plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/go_use_plugin/index.html.md): The Go-use plugin allows for setting up a [go workspace](https://go.dev/blog/get-familiar-with-works... - [Meson plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/meson_plugin/index.html.md): The Meson plugin configures projects using [Meson](https://mesonbuild.com/) and builds them using [N... - [Go plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/go_plugin/index.html.md): The Go plugin builds [Go](https://go.dev/) modules, which are collections of packages stored in a fi... - [Poetry plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/poetry_plugin/index.html.md): The Poetry plugin can be used for Python projects that use the [Poetry](https://python-poetry.org) b... - [Autotools plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/autotools_plugin/index.html.md): The plugin makes use of the following tools: - [Python plugin (v2)](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/python_v2_plugin/index.html.md): The Python plugin (v2) is the successor to the [Python plugin](https://documentation.ubuntu.com/craf... - [.NET plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/dotnet_plugin/index.html.md): The `dotnet` plugin builds .NET projects using the `dotnet` tool. - [Rust plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/rust_plugin/index.html.md): Reference for the Rust plugin, including its configuration keys, Rust toolchain behavior, and example part definitions in YAML. - [.NET plugin (v2)](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/dotnet_v2_plugin/index.html.md): The .NET plugin (v2) builds .NET projects using the [dotnet](https://learn.microsoft.com/en-us/dotne... - [Cargo-use plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/cargo_use_plugin/index.html.md): The Cargo-use plugin sets up a local [cargo registry](https://doc.rust-lang.org/cargo/reference/regi... - [JLink plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/jlink_plugin/index.html.md): The [JLink](https://docs.oracle.com/en/java/javase/21/docs/specs/man/jlink.html) plugin can be used ... - [SCons plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/scons_plugin/index.html.md): The SCons plugin builds projects using [SCons](https://scons.org/). - [Colcon plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/colcon_plugin/index.html.md): The colcon plugin manages the [colcon](https://colcon.readthedocs.io/) build tool inside a part. - [Qmake plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/qmake_plugin/index.html.md): The qmake plugin configures projects using [qmake](https://doc.qt.io/qt-6/qmake-manual.html), and bu... - [npm plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/npm_plugin/index.html.md): The npm plugin can be used for Node.js projects that use npm (or Yarn) as the package - [Dump plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/dump_plugin/index.html.md): The Dump plugin can be used for any project where you want to include existing files - [Ruby plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/ruby_plugin/index.html.md): Reference for parts built with the Ruby plugin. Review the plugin's special configuration keys and see working examples of Ruby parts in YAML. - [CMake plugin](https://documentation.ubuntu.com/craft-parts/latest/common/craft-parts/reference/plugins/cmake_plugin/index.html.md): The CMake plugin configures projects using [CMake](https://cmake.org) and builds them --- For more comprehensive documentation, see [llms-full.txt](https://documentation.ubuntu.com/craft-parts/latest/llms-full.txt)