# Unofficial python stubs for Pixar's Universal Scene Description (USD)
These stubs are designed to be used with a type checker like `mypy` to provide static type checking of python code, as well as to provide analysis and completion in IDEs like PyCharm and VSCode (with Pylance).
## Installing
```commandline
pip install types-usd
```
The version of the package corresponds to the version of USD that it is generated from,
plus a version suffix for the revision of the stubs
The stubs have been tested against a large USD codebase using `mypy`, however, there
are still known issues that need to be resolved.
Using these stubs with `mypy` will produce erros within the stubs themselves, mostly about
missing/unknown types. I've left these errors unsilenced as a reminder to fix them.
I recommend adding the following config to your `mypy.ini` to silence these errors:
```ini
[mypy-pxr.*]
ignore_errors = true
```
If you find any other issues, please report them on the [github issues page](https://github.com/LumaPictures/cg-stubs/issues).
## Developing
The stubs are created using information extracted from python signatures generated
by boost-python in each function's docstring, combined with data parsed as from the USD C++ docs.
Currently, creating the stubs requires custom forks of mypy and USD, but I hope to have
my changes merged into upstream soon.
Raw data
{
"_id": null,
"home_page": "https://github.com/LumaPictures/cg-stubs",
"name": "types-usd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "3d, graphics, games, VFX, CG, animation",
"author": "Chad Dombrova",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1e/2e/b27175e276886dece2660c527556981dbf9465b977826e8b602500113fed/types_usd-24.5.2.tar.gz",
"platform": null,
"description": "# Unofficial python stubs for Pixar's Universal Scene Description (USD)\n\nThese stubs are designed to be used with a type checker like `mypy` to provide static type checking of python code, as well as to provide analysis and completion in IDEs like PyCharm and VSCode (with Pylance).\n\n## Installing\n\n```commandline\npip install types-usd\n```\n\nThe version of the package corresponds to the version of USD that it is generated from,\nplus a version suffix for the revision of the stubs\n\nThe stubs have been tested against a large USD codebase using `mypy`, however, there\nare still known issues that need to be resolved.\n\nUsing these stubs with `mypy` will produce erros within the stubs themselves, mostly about \nmissing/unknown types. I've left these errors unsilenced as a reminder to fix them. \nI recommend adding the following config to your `mypy.ini` to silence these errors:\n\n```ini\n[mypy-pxr.*]\nignore_errors = true\n```\n\nIf you find any other issues, please report them on the [github issues page](https://github.com/LumaPictures/cg-stubs/issues).\n\n## Developing\n\nThe stubs are created using information extracted from python signatures generated\nby boost-python in each function's docstring, combined with data parsed as from the USD C++ docs.\n\nCurrently, creating the stubs requires custom forks of mypy and USD, but I hope to have\nmy changes merged into upstream soon.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Unofficial python stubs for Pixar's Universal Scene Description (USD)",
"version": "24.5.2",
"project_urls": {
"Homepage": "https://github.com/LumaPictures/cg-stubs",
"Repository": "https://github.com/LumaPictures/cg-stubs"
},
"split_keywords": [
"3d",
" graphics",
" games",
" vfx",
" cg",
" animation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a93877e716ff072350c3ae98da836e26080ffaf72e5da41c301dad55d23d8897",
"md5": "ea7ee4492d72583af9c42fd12592ac21",
"sha256": "e696c40f7aec7fa3f65f14d26345b9b747d9004616bcd9fb01c85d4bb52b3d68"
},
"downloads": -1,
"filename": "types_usd-24.5.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea7ee4492d72583af9c42fd12592ac21",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 541467,
"upload_time": "2024-08-21T03:40:43",
"upload_time_iso_8601": "2024-08-21T03:40:43.139941Z",
"url": "https://files.pythonhosted.org/packages/a9/38/77e716ff072350c3ae98da836e26080ffaf72e5da41c301dad55d23d8897/types_usd-24.5.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1e2eb27175e276886dece2660c527556981dbf9465b977826e8b602500113fed",
"md5": "c4739f09f577c5a3d9a5a8923562a3c1",
"sha256": "5da654fdc17dfb8ddf2b264c626e5236e6572b5359498c5ec634b5577abe86fa"
},
"downloads": -1,
"filename": "types_usd-24.5.2.tar.gz",
"has_sig": false,
"md5_digest": "c4739f09f577c5a3d9a5a8923562a3c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 487745,
"upload_time": "2024-08-21T03:40:44",
"upload_time_iso_8601": "2024-08-21T03:40:44.950361Z",
"url": "https://files.pythonhosted.org/packages/1e/2e/b27175e276886dece2660c527556981dbf9465b977826e8b602500113fed/types_usd-24.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-21 03:40:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LumaPictures",
"github_project": "cg-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "docstring_parser",
"specs": []
},
{
"name": "mypy",
"specs": []
}
],
"lcname": "types-usd"
}
JSON
