Skip to main content

License: GPL v3 PyPI Blender Tests Platform

blendertk

Blender 4.x+ tech-art toolkit mirroring mayatk's public API (btk.X ↔ mtk.X) — modeling, animation, materials, rigging, and scene-pipeline automation over native bpy/bmesh, plus one-click bridges into Marmoset, Substance Painter, RizomUV, Maya, Unity, and the browser. The tool panels over it are tentacle's.

blendertk is the Blender layer of the pythontk → uitk → {mayatk, blendertk} → tentacle ecosystem. It mirrors mayatk at the name + behavior level — and by signature where a shared panel calls the operation, never by line count — so the shared tentacle panels stay branch-free across DCCs. Where Blender ships the capability natively, blendertk stays a thin adapter over bpy/bmesh operators; where it doesn't, the DCC-agnostic core lives upstream in pythontk and both DCC layers adapt it.

blendertk (highlighted) in the ecosystem: uitk requires pythontk; unitytk requires pythontk; mayatk requires uitk; blendertk requires uitk; tentacle requires uitk; extapps requires uitk; tentacle installs mayatk as its [maya] extra; tentacle installs blendertk as its [blender] extra; tentacle opens extapps by name (its [apps] extra) and never imports it; mayatk and blendertk share a mirrored API. tentacle and extapps are products, which nothing imports.

Installation

pip install blendertk

Requirements: Blender 4.x+ (developed against 5.1 / Python 3.13) · pythontk. bpy is provided by the Blender runtime — importing blendertk and resolving its surface never needs a running Blender (all bpy imports are deferred into call bodies).

Packages

Same subpackage names, main-module filenames, and namespace classes as mayatk — the full correspondence map (including what is deliberately absent on each side, and why) is STRUCTURE.md.

Package What it covers
anim_utils Shots suite (the Blender host of the shared pythontk shots engine, and the manifest and sequencer hosts tentacle's panels call), smart bake, blendshape animation, playblast, key scaling/staggering
audio_utils Sound-strip CRUD over the Video Sequence Editor (deliberately not a mirror of Maya's DG-node audio machinery)
cam_utils Camera utilities
core_utils CoreUtils, AutoInstancer, Preview (uitk's PreviewController bound to a Blender session), script-job manager over bpy.app.handlers, diagnostics
display_utils Color ID, exploded view, Blender-only OutlinerTint
edit_utils EditUtils, mirror, cut-on-axis, duplicate (linear/radial/grid), bevel, bridge, snap, naming, curtain rig, target weld
env_utils BlenderConnection, BlenderSceneFiles (the blender operation host: a fresh background Blender per python -m pythontk ops call, one kept per MCP session), workspaces (workspace.mel shared with Maya), reference manager, hierarchy sync, FBX/USD, scene exporter, Maya + Unity bridges, WebXR preview, docked script console
light_utils Lightmap baker + web export, HDR manager, lights-from-geometry
mat_utils Game shader, material updater, texture path editor, shader templates, render opacity, image-to-plane, emissive groups, Marmoset + Substance live-RPC bridges
node_utils NodeUtils, DataNodes (shared scene data carriers), the Channels engine
nurbs_utils Curve helpers (relaxed mirror), ImageTracer, curve-to-tube
render_utils Render engines, render settings + presets, render cameras, a rendered frame (mayatk's names; no IPR)
rig_utils Constraints/drivers/armature primitives; tube / wheel / telescope / shadow / articulated rigs
ui_utils BlenderUiHandler, BlenderMarkingMenuHost (the uitk.MarkingMenuHost adapter, over QtRuntime and the 3D View KeymapBridge), native-menu wrapper, Qt dock container, calculator, style setter
uv_utils UV utilities, Texture Combine (material atlas combine + UV / texture transfer), Rizom bridge
xform_utils Transforms and matrix IO

Classes — and, for the wildcard-scanned *_utils roots, their public methods — are exposed at the package root via the lazy-loading resolver:

import blendertk as btk

btk.selected_objects()                      # bare form — CoreUtils.selected_objects, wildcard-exposed
btk.EditUtils.mirror(...)                   # class-qualified — mirrors mtk.EditUtils.mirror
btk.AutoInstancer(tolerance=0.001).run()    # same call in mayatk: mtk.AutoInstancer(...).run()

Full public surface, searched live from the installed source: python -m pythontk ops run api.search "query=<words>".

Highlights

  • Maya bridge, both directions — MayaBridge.send() exports the selection and launches an interactive Maya on it; save_as() runs mayapy headlessly and returns a written .ma/.mb; MayaSceneImport pulls a Maya scene in via a blocking headless FBX round-trip, translating FBX-hostile shaders and rebuilding packed PBR maps from a manifest sidecar. Mirrored by mayatk's BlenderBridge, so each DCC reads and writes the other's native format off one shared export pipeline.
  • Lightmap pipeline — LightmapBaker commits bake state (markers + manifest) that every exporter reads on its own: Unity via the FBX carrier, GLB via pythontk's lightmap applier, and LightmapWebExport wraps Blender's own glTF exporter for the live WebXR preview — a clean no-op on unbaked scenes. mayatk's Blender bridge drives this baker headlessly for the Maya round trip.
  • Drive Blender from outside — BlenderConnection mirrors mayatk's MayaConnection: fresh --background instances only, the backbone of the test suite. An artist's open session is never touched.
  • Hierarchy sync — diff a scene against a reference .blend (or .fbx, staged to a temp .blend) linked as a library, then repair drift: stub missing objects, quarantine extras, fix fuzzy renames and reparents; ObjectSwapper pulls matched reference objects in fresh.
  • Shared workspaces — one project folder serves Maya natively and Blender via blendertk: the workspace.mel codec and template store live in pythontk, and the editor part of tentacle's Workspaces panel mirrors Maya's Project Window.
  • Tool panels — blendertk holds no UI: each tool's panel is one tentacle panel shared with Maya, calling this package's API, so a script gets everything the panel does.

Parity — how the mirror stays honest

Parity is measured, not eyeballed: compare_panel_surface.py resolves every call tentacle's shared panels make through self.tk on both mayatk and blendertk (tentacle/docs/PARITY_SURFACE.md); a call one host lacks must be hidden (requires) or guarded there, else it fails the gate. The coarse gap and port-this-next recipes live in PARITY_AUDIT.md and PARITY_PORTING_PLAN.md.

Session safety

Nothing in blendertk attaches to a running Blender. Tests and headless tooling always launch a fresh blender --background --factory-startup process; BlenderConnection does the same. See AGENTS.md for the full rule.

Guides

  • Scene data nodes — the data_internal / data_export carriers and how their metadata rides into the FBX (Blender delta of mayatk's owner doc)
  • Shot Sequencer (mayatk, one guide for both hosts) — the per-shot animation timeline and its graph view; the panel's ? help links here
  • Emissive groups (mayatk, cross-package reference) — regions whose glow plays on its own, as materials; blendertk's EmissiveGroups tags each copy on its node tree
  • Live WebXR preview (pythontk) — the shared DCC → glTF → headset pipeline behind btk.WebXrPreview

License

GPL-3.0-or-later — see COPYING, plus an additional permission to combine it with mayatk, tentacle and Autodesk Maya (COPYING.EXCEPTION).

Metadata

Release files for blendertk 0.25.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for blendertk 0.25.1
File Interpreter ABI Platform Actions
blendertk-0.25.1-py3-none-any.whl Python 3 none any Details for blendertk-0.25.1-py3-none-any.whl

Release files / blendertk-0.25.1-py3-none-any.whl

Download URL blendertk-0.25.1-py3-none-any.whl
Size 1.9 MB
Tags Python 3
SHA-256 checksum
How to use checksums
01a261f764f983533029cccce0dc417e6686aac618f1362652e7246c3c160b33
BLAKE2b-256 checksum
How to use checksums
5e341b9462a006c5232433af3c381dfa11cefb7907283830b0e1eb3ba77205c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.18

Security for blendertk 0.25.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.25.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page