Skip to main content

A comprehensive toolkit for Autodesk Maya providing utilities for modeling, animation, rigging, and UI management.

Project description

License: MIT Version Python Maya Tests

mayatk

A collection of utility classes and helper functions for Autodesk Maya — modeling, rigging, animation, materials, scene management, and UI tooling. Built on maya.cmds + maya.api.OpenMaya (no PyMEL).

Installation

pip install mayatk

Requirements: Maya 2025+ (Python 3.11+).

mayatk also ships mayapy-package-manager.bat — an interactive Windows menu for installing/updating/backing up packages in Maya's bundled Python interpreter.


Packages

Package What it covers
anim_utils Animation curves, shots, blendshape animation, playblast, smart bake
audio_utils Audio clips, ffmpeg-backed conversion, timeline-keyed events
cam_utils Camera utilities and default-camera handling
core_utils CoreUtils, Components, AutoInstancer, MASH bridge, diagnostics, preview
display_utils Display layers, color management, exploded view
edit_utils Selection, naming, primitives, snap, bevel, bridge, mirror, duplicate (linear/radial/grid), mesh graph
env_utils MayaConnection, workspace, namespace sandbox, references, hierarchy manager, FBX, scene exporter
light_utils Lighting helpers
mat_utils GameShader, RenderOpacity, ImageToPlane, MatUpdater, shader templates, Marmoset bridge
node_utils NodeUtils, Attributes, event triggers, shared scene data nodes
nurbs_utils NURBS surfaces, ImageTracer
rig_utils Controls, ShadowRig
ui_utils MayaUiHandler, channel box, native menus, hotkey collision check, node icons
uv_utils UV utilities, Rizom bridge
xform_utils Transforms, matrices, pivot watcher

Classes and module-level functions are exposed at the package root via the lazy-loading resolver. Both bare and class-qualified forms work:

import mayatk as mtk

@mtk.undoable                           # bare form — wildcard-exposed
def operation():
    mtk.freeze_transforms("pCube1")

# Class-qualified form — explicit, no risk of collision
mtk.NodeUtils.is_group("group1")
mtk.XformUtils.freeze_transforms("pCube1")
mtk.EnvUtils.SCENE_UNIT_VALUES

sel = mtk.Selection()

For the full public surface (auto-generated, refreshed bi-weekly) see API_REGISTRY.md.


Bundled UITK Editors

MayaUiHandler ships with a one-line entry point for launching the uitk editor windows from a Maya shelf button or script:

from mayatk.ui_utils.maya_ui_handler import MayaUiHandler
MayaUiHandler.instance().editors.show("browser")
Editor key Description
browser Searchable launcher for every UI registered with the switchboard — tags, filtering, hide lists, launch options, JSON-portable presets.
style Theme + QSS variable editor for live restyling of the dark/light themes.
hotkey Keyboard-shortcut editor for slots registered with the switchboard.

MayaUiHandler.instance() is reentrant: if tentacle (or any other tool) already created the handler, the call returns the existing singleton; otherwise it bootstraps one with a fresh Switchboard. The editor window is cached per-handler — clicking the shelf button twice focuses the existing window rather than spawning a duplicate.


Session safety

MayaConnection.connect() defaults to launch=True, force_new_instance=True — every call launches a fresh Maya on an unused port. The user's open session is never touched. The test runner (test/run_tests.py) defaults the same way; only --reuse overrides, and you should not pass it. See CLAUDE.md for the full rule.


Guides

  • Scene data nodes — the shared data_internal / data_export two-node model that every tool uses to stash scene-wide metadata and (optionally) embed it in an FBX.
  • Shot data in the FBX → Unity — exporting Shots as named Unity AnimationClips plus embedded shot metadata, and side-by-side coexistence with Audio events.

Links

License

MIT — see LICENSE.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

mayatk-0.12.36-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file mayatk-0.12.36-py3-none-any.whl.

File metadata

  • Download URL: mayatk-0.12.36-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for mayatk-0.12.36-py3-none-any.whl
Algorithm Hash digest
SHA256 239640f58b4681352efbfc8a239470164210d0f7b306c6ec5481c76864e854dc
MD5 7e8ba75fc5adb0cb03821c6e4bf02d0e
BLAKE2b-256 59d7d86a22988de17c0cc5ec81e4f09ed9563505d90fbb32a9dddefae1b73412

See more details on using hashes here.

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