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.3.tar.gz (44.8 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.3-py3-none-any.whl (46.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peeler-0.1.3.tar.gz
  • Upload date:
  • Size: 44.8 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.3.tar.gz
Algorithm Hash digest
SHA256 b1d395d695894ab879d81f2e7238efc906631b161d221aa324635accc85586b7
MD5 c7418e4555daa75f7fedbefd8ff0bc2c
BLAKE2b-256 41b4ac6130cbbc2ff4ed5be02c0d5a33e1ae47c6ed6baa6fe7071786477d16a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for peeler-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: peeler-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 46.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2f71b53f0ac8e0e208455573e0731464b697dda7344f9cafe56d6567b924e020
MD5 c61e1dbf8f17aa470d126ecf8c479131
BLAKE2b-256 e57048dfc456e32bf8287c34b3a0cf7d84870a83ab37817373df8cdb28a18098

See more details on using hashes here.

Provenance

The following attestation bundles were made for peeler-0.1.3-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