Skip to main content

A generator for Rust/Cargo ebuilds written in Python

Project description

Author:

Michał Górny

License:

GPL-2.0-or-later

Homepage:

https://github.com/projg2/pycargoebuild/

pycargoebuild is a generator for ebuilds using the Cargo infrastructure of Rust language. It is primarily meant to aid in keeping the list of CRATES and their LICENSE up-to-date. It is a rewrite of the cargo-ebuild tool in Python, with no actual dependency on Rust.

pycargoebuild reads Cargo.toml and Cargo.lock files in order to obtain the package’s metadata and dependency list, respectively. Then it fetches all dependent crates into DISTDIR and reads their Cargo.toml files to construct the complete list of licenses. The resulting data can either be used to construct a new ebuild from a template or to update the values of CRATES and LICENSE in an existing ebuild.

Why not cargo-ebuild?

pycargoebuild has the following features that cargo-ebuild 0.5.2 is missing:

  • small size (cargo-ebuild compiles to 5.5M on my system)

  • full support for SPDX-2.0 license expressions with boolean simplification (whereas cargo-ebuild just dumps all licenses it finds)

  • pretty-printing with line wrapping for license expressions

  • support for updating CRATES and crate LICENSE in existing ebuilds (whereas cargo-ebuild can only generate new ebuilds)

  • support for combining the data from multiple subpackages (useful e.g. in setuptools-rust)

  • support for fast crate fetching if aria2c is installed

  • support for skipping crate licenses (e.g. for when Crates are used at build/test time only)

Usage

To create a new ebuild, run:

pycargoebuild <package-directory>

where package-directory is the directory containing Cargo.toml. This creates an ebuild file named after the package name and version in the current directory, and outputs its name.

To update an existing ebuild, use instead:

pycargoebuild -i <current-file>.ebuild <package-directory>

Note that the existing file must contain both CRATES variable and LICENSE+= assignment like the following:

# Dependent crate licenses
LICENSE+="..."

It is also possible to explicitly specify the output filename using the -o option.

Configuration file

pycargoebuild can additionally be configured using pycargoebuild.toml in one of the XDG config directories (usually ~/.config). The following example provides a quick summary of configuration options available:

[paths]
# default --distdir, Portage config is used if not set
distdir = "/var/cache/portage/distfiles"
# default --license-mapping, "metadata/license-mapping.conf" from
# ::gentoo repo (via Portage API) is used if not set
license-mapping = "/var/db/repos/gentoo/metadata/license-mapping.conf"

[license-overrides]
# provide an SPDX license string for packages missing the metadata
nihav_codec_support = "MIT"
nihav_core = "MIT"
nihav_duck = "MIT"

[license-mapping]
# additional mappings from SPDX licenses to Gentoo licenses
"LicenseRef-UFL-1.0" = "UbuntuFontLicense-1.0"

Project details


Download files

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

Source Distribution

pycargoebuild-0.15.0.tar.gz (59.8 kB view details)

Uploaded Source

Built Distribution

pycargoebuild-0.15.0-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file pycargoebuild-0.15.0.tar.gz.

File metadata

  • Download URL: pycargoebuild-0.15.0.tar.gz
  • Upload date:
  • Size: 59.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pycargoebuild-0.15.0.tar.gz
Algorithm Hash digest
SHA256 c1df801f8d2bef9b8401ceb8a6de9816017e12da3bee68f07e3ab7bf9b76083c
MD5 f1ac1f95c80dccf7d1781ef8144a49b4
BLAKE2b-256 7b7fcd029f6f209ae40bb0d8637ddd4db378e6fcc40e7fd0355b013135052164

See more details on using hashes here.

File details

Details for the file pycargoebuild-0.15.0-py3-none-any.whl.

File metadata

  • Download URL: pycargoebuild-0.15.0-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for pycargoebuild-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1c8acfcfa828ce492f6fa2fb231f4ddd8a9edd5bb48d7b0265e387519717d82
MD5 961c1b99480414f64b41a1ba330043a0
BLAKE2b-256 53512beda19cf9e8f5bda395488d54fd04a0d57514f1cea933313078b6f5ce82

See more details on using hashes here.

Supported by

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