Skip to main content

A tool to use a `pyproject.toml` instead of a `blender_manifest.toml` to build Blender add-ons

Project description

Peeler

A tool to use a pyproject.toml file instead (or alongside) of the blender_manifest.toml required for building blender add-ons since Blender 4.2 .

To install run:

pip install peeler

Features

Manifest

Create a blender_manifest.toml from fields in a pyproject.toml

  • Make sure to have a pyproject.toml with basic field values:
# pyproject.toml

[project]
name = "My Awesome Addon"
version = "1.0.0"
  • Some meta-data are specific to Blender, such as blender_version_min, you can specify theses in your pyproject.toml file under the [tool.peeler.manifest] table, here's a minimal pyproject.toml working version:
# pyproject.toml

[project]
name = "My Awesome Addon"
version = "1.0.0"

[tool.peeler.manifest]
blender_version_min = "4.2.0"
id = "my_awesome_addon"
license = ["SPDX:0BSD"]
maintainer = "John Smith"
tagline = "My Add-on is awesome"
  • Run peeler to create (or update) blender_manifest.toml:
peeler manifest /path/to/your/pyproject.toml /path/to/blender_manifest.toml
# created blender_manifest.toml

version = "1.0.0"
name = "My Awesome Addon"
schema_version = "1.0.0"
type = "add-on"
blender_version_min = "4.2.0"
id = "my_awesome_addon"
license = ["SPDX:0BSD"]
maintainer = "John Smith"
tagline = "My Add-on is awesome"

The manifest is filled with values from the pyproject [project], [tool.peeler.manifest] tables and default values.

To get a full list of values required or optional in a blender_manifest.toml visit https://docs.blender.org/manual/en/latest/advanced/extensions/getting_started.html#manifest

Authors

  • Maxime Letellier - Initial work

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

peeler-0.1.5.tar.gz (45.0 kB view details)

Uploaded Source

Built Distribution

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

peeler-0.1.5-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file peeler-0.1.5.tar.gz.

File metadata

  • Download URL: peeler-0.1.5.tar.gz
  • Upload date:
  • Size: 45.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for peeler-0.1.5.tar.gz
Algorithm Hash digest
SHA256 fba51f568a797c6acb909e0e606ef65b2e5f82ef602c41fcf558f7d182069ad1
MD5 21deabd2ef40c8b20f8272e6ec29aae8
BLAKE2b-256 76c6d6c335db15170d18d2a5d84a715f7477170a27ed654f56dd12818d6c0315

See more details on using hashes here.

Provenance

The following attestation bundles were made for peeler-0.1.5.tar.gz:

Publisher: release.yaml on Maxioum/Peeler

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

File details

Details for the file peeler-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: peeler-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for peeler-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1b87ad2c4979d504022e427532d9ec1bb3854b7df48122e404286365da809453
MD5 808c8bdf9dc987bcc97cf35f45997f3c
BLAKE2b-256 ca5d677cfb48aa2d655a2ac50c315f0fcb2a359a889d11159fd6508890ee38e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for peeler-0.1.5-py3-none-any.whl:

Publisher: release.yaml on Maxioum/Peeler

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

Supported by

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