/maya-stubs

Stubs for Autodesk Maya

Primary LanguagePythonMIT LicenseMIT

Maya Stubs

Type Annotated Stubs for Autodesk Maya's python APIs

Goals

Provide fully type annotated stubs for maya.cmds and OpenMaya 1.0 & 2.0

Status

Note that is very much in progress and it is unlikely that the stubs will ever be perfect.
At this point, even if some of the maya.cmds annotations are wrong/misleading, I would consider it a better experience than using the stubs from the devkit. The stubs from OpenMaya 1.0 and 2.0 are very minimal and only have *args, **kwargs signatures, which should be pretty close to the devkit stubs.

  • 🚧 maya.cmds: In Progress
    • Stubs for all commands.
    • Accurate Arguments signatures for most commands. Parsed from the HTML Docs or the synopsys from cmds.help("command")
    • Accurate Positional Only Arguments for most command.
    • Accurate Return types on most commands
    • Docstrings.
    • Accurate Arguments signatures all commands.
    • Accurate Return types all most commands
  • 🚧 OpenMaya 1.0: Incomplete
    • Stubs for all members
    • Accurate Argument Signatures
    • Return Types
    • Docstrings.
  • 🚧 OpenMaya 2.0: Incomplete
    • Stubs for all members
    • Accurate Argument Signatures
    • Return Types
    • Docstrings.

Installation

You can get the stubs with one of two ways:

  1. Run pip install maya-stubs from the python executable used by your IDE.
  2. Download them manually from the Github releases and let your IDE know of their location.