# 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
- [x] Stubs for all commands.
- [x] Accurate Arguments signatures for most commands.
Parsed from the HTML Docs or the synopsys from `cmds.help("command")`
- [x] Accurate Positional Only Arguments for most command.
- [x] Accurate Return types on most commands
- [x] Docstrings.
- [ ] Accurate Arguments signatures all commands.
- [ ] Accurate Return types all most commands
- 🚧 OpenMaya 1.0: Incomplete
- [x] Stubs for all members
- [ ] Accurate Argument Signatures
- [ ] Return Types
- [ ] Docstrings.
- 🚧 OpenMaya 2.0: Incomplete
- [x] Stubs for all members
- [ ] Accurate Argument Signatures
- [ ] Return Types
- [x] 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](https://github.com/Muream/maya-stubs/releases) and let your IDE know of their location.
## Notes
### PyCharm maya.cmds completion
PyCharm users may not see code completion for `maya.cmds` as the editor limits code insight features by default on files over 2.5 MB for performance reasons. Currently the cmds stub is over this limit.
This value can be increased in [PyCharm's properties](https://www.jetbrains.com/help/pycharm/file-idea-properties.html), accessible via the `Help > Edit Custom Properties` menu.
Code completion should work after adding the line below to the properties file and restarting PyCharm. This example overrides the default value from 2.5 MB to 10 MB. The value may be customized as needed, but keep in mind it can affect editor performance.
```
idea.max.intellisense.filesize = 10000
```
Raw data
{
"_id": null,
"home_page": "https://www.github.com/Muream/maya-stubs",
"name": "maya-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*",
"maintainer_email": "",
"keywords": "stubs,autodesk,maya,cmds,OpenMaya",
"author": "Lo\u00efc Pinsard",
"author_email": "muream@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d1/76/22b910b2ebbcc306edac24c248fecc78591398a8d8500fa1c53263ea2973/maya_stubs-0.4.1.tar.gz",
"platform": null,
"description": "# Maya Stubs\n\nType Annotated Stubs for Autodesk Maya's python APIs\n\n## Goals\n\nProvide fully type annotated stubs for maya.cmds and OpenMaya 1.0 & 2.0\n\n\n## Status\n\nNote that is very much in progress and it is unlikely that the stubs will ever be perfect. \nAt 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.\nThe 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.\n\n- \ud83d\udea7 maya.cmds: In Progress\n - [x] Stubs for all commands.\n - [x] Accurate Arguments signatures for most commands.\n Parsed from the HTML Docs or the synopsys from `cmds.help(\"command\")`\n - [x] Accurate Positional Only Arguments for most command.\n - [x] Accurate Return types on most commands\n - [x] Docstrings.\n - [ ] Accurate Arguments signatures all commands.\n - [ ] Accurate Return types all most commands\n- \ud83d\udea7 OpenMaya 1.0: Incomplete\n - [x] Stubs for all members\n - [ ] Accurate Argument Signatures\n - [ ] Return Types\n - [ ] Docstrings.\n- \ud83d\udea7 OpenMaya 2.0: Incomplete\n - [x] Stubs for all members\n - [ ] Accurate Argument Signatures\n - [ ] Return Types\n - [x] Docstrings.\n\n\n## Installation\n\nYou can get the stubs with one of two ways:\n\n1. Run `pip install maya-stubs` from the python executable used by your IDE.\n2. Download them manually from the [Github releases](https://github.com/Muream/maya-stubs/releases) and let your IDE know of their location.\n\n## Notes\n\n### PyCharm maya.cmds completion\n\nPyCharm users may not see code completion for `maya.cmds` as the editor limits code insight features by default on files over 2.5 MB for performance reasons. Currently the cmds stub is over this limit.\n\nThis value can be increased in [PyCharm's properties](https://www.jetbrains.com/help/pycharm/file-idea-properties.html), accessible via the `Help > Edit Custom Properties` menu.\n\nCode completion should work after adding the line below to the properties file and restarting PyCharm. This example overrides the default value from 2.5 MB to 10 MB. The value may be customized as needed, but keep in mind it can affect editor performance.\n\n```\nidea.max.intellisense.filesize = 10000\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Type Annotated Stubs for Autodesk Maya's python APIs",
"version": "0.4.1",
"project_urls": {
"Homepage": "https://www.github.com/Muream/maya-stubs",
"Repository": "https://www.github.com/Muream/maya-stubs"
},
"split_keywords": [
"stubs",
"autodesk",
"maya",
"cmds",
"openmaya"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9fce3b4b049140e19df5735adee90087db05f46558dad7a46ada684318c0e63a",
"md5": "2c1bfe7a9d5a95bce205fa2b29aba490",
"sha256": "d17e4b5bfced49d333991a1df0815c3eb159fce88fce0b23cb5e10d53d3480a7"
},
"downloads": -1,
"filename": "maya_stubs-0.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2c1bfe7a9d5a95bce205fa2b29aba490",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*",
"size": 1376766,
"upload_time": "2024-01-16T22:20:21",
"upload_time_iso_8601": "2024-01-16T22:20:21.751746Z",
"url": "https://files.pythonhosted.org/packages/9f/ce/3b4b049140e19df5735adee90087db05f46558dad7a46ada684318c0e63a/maya_stubs-0.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d17622b910b2ebbcc306edac24c248fecc78591398a8d8500fa1c53263ea2973",
"md5": "834a0b9ed7073ab971314fcc53ee119d",
"sha256": "d9b8c515da2a446fdc493853a7dacb2758183208aef2f6f13e190c3d009cc8d5"
},
"downloads": -1,
"filename": "maya_stubs-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "834a0b9ed7073ab971314fcc53ee119d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*",
"size": 1358046,
"upload_time": "2024-01-16T22:20:25",
"upload_time_iso_8601": "2024-01-16T22:20:25.811490Z",
"url": "https://files.pythonhosted.org/packages/d1/76/22b910b2ebbcc306edac24c248fecc78591398a8d8500fa1c53263ea2973/maya_stubs-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-16 22:20:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Muream",
"github_project": "maya-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "maya-stubs"
}
JSON
