# 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": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "3d,graphics,games,VFX,CG,animation",
"author": "Chad Dombrova",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/37/08/f71841f1d9b5037a3852f129acb10cbb11f3869177aeec262d9ba15cdb95/types_usd-23.5.4.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": "23.5.4",
"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": "d2229e46f34a18137d4ce8ccaf9a9e481d27a578beae9fe970bd493c010908ed",
"md5": "3246033876254d387fd775d404008cd4",
"sha256": "9de9e330d7a4a7cb5006c8584899f705ff1f73703ad5b866f267b1d591681622"
},
"downloads": -1,
"filename": "types_usd-23.5.4-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3246033876254d387fd775d404008cd4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 143731,
"upload_time": "2023-08-04T21:03:55",
"upload_time_iso_8601": "2023-08-04T21:03:55.324781Z",
"url": "https://files.pythonhosted.org/packages/d2/22/9e46f34a18137d4ce8ccaf9a9e481d27a578beae9fe970bd493c010908ed/types_usd-23.5.4-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3708f71841f1d9b5037a3852f129acb10cbb11f3869177aeec262d9ba15cdb95",
"md5": "56e56e35f56ebe4bcb9b6e32201492a4",
"sha256": "916faf1868896e5c16ca9e2039d4b3f372391f9e0569728b24ba14f72ed71a7a"
},
"downloads": -1,
"filename": "types_usd-23.5.4.tar.gz",
"has_sig": false,
"md5_digest": "56e56e35f56ebe4bcb9b6e32201492a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 103902,
"upload_time": "2023-08-04T21:03:57",
"upload_time_iso_8601": "2023-08-04T21:03:57.834287Z",
"url": "https://files.pythonhosted.org/packages/37/08/f71841f1d9b5037a3852f129acb10cbb11f3869177aeec262d9ba15cdb95/types_usd-23.5.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-04 21:03:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LumaPictures",
"github_project": "cg-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "types-usd"
}
JSON
