Repository files navigation

Website

USD Manager is an open-source, python-based Qt tool for browsing, managing, and editing text-based files like USD,combining the best features from your favorite web browser and text editor into one application, with hooks to deeplyintegrate with other pipeline tools. It is developed and maintained byDreamWorks Animationfor use with USD and other hierarchical, text-based workflows, primarily geared towards feature film production. Whileoriginally designed around PyQt4, USD Manager uses the Qt.py compatibility library to allow working with PyQt4, PyQt5,PySide, or PySide2 for Qt bindings.

This GitHub repository hosts the trunk of the USD Manager development. This implies that it is the newest publicversion with the latest features and bug fixes. However, it also means that it has not undergone a lot of testing andis generally less stable than theproduction releases.

USD Manager is released under theApache License, Version 2.0, which isa free, open-source, and detailed software license developed and maintained by the Apache Software Foundation.

• Installing USD Manager
  • Requirements
  • Install with setup.py
• Using USD Manager
  • Keyboard shortcuts
• Development / Customization
• Contributing

usdmanager requiresPython 2 (for Python 3, see thepython3 branch),Qt.py andsetuptools(can be handled by setup.py), and one of Qt.py's four supported Qt bindings, which will need to be installed separately.

Additionally, an installation ofUSD itself is recommended but not required for all use cases.Installing USD provides access to file path resolvers, non-ASCII USD formats, and plug-ins like usdview.All USD versions should be supported.

For a site-wide install, try:

python setup.py install

For a personal install, try:

python setup.py install --user

Studios with significant python codebases or non-trivial installs may need to customizesetup.py.

Your PATH and PYTHONPATH will need to be set appropriately to launch usdmanager,and this will depend on your setup.py install settings.

For more OS-specific installation notes, known issues, and common problems, seeInstalling USD Manager.

Once you have installed usdmanager, you can launch from the command line:

usdmanager

You can also specify one or more files to open directly:

usdmanager shot.usd

For more documentation on usage, seeUsing USD Manager

For a full list of keyboard shortcuts, seeKeyboard Shortcuts

Most customization of the app is through theusdmanager/config.json file.

For a full list of all customization options, seeDevelopment / Customization

Developers who wish to contribute code to be considered for inclusion in the USD Manager distribution must firstcomplete theContributor License Agreementand submit it to DreamWorks (directions in the CLA). We prefer code submissions in the form of pull requests to thisrepository.

Every commit must be signed off. That is, every commit log message must include a "Signed-off-by" line (generated, for example, with"git commit --signoff"), indicating that the committer wrote the code and has the right to release it under theApache 2.0 license. Seehttp://developercertificate.org/ for moreinformation on this requirement.

1. Fork the repository on GitHub
2. Clone it locally
3. Build a local copy

python setup.py install --userpip install -r docs/requirements.txt

4. Write code, following thestyle guide.
5. Test it
6. Update any manual documentation pages (like this one)
7. Test that the documentation builds without errors with:

sphinx-build -b html docs/ docs/_build

8. Commit changes to the dev branch, signing off on them per the code signing instructions, thenpush the changes to your fork on GitHub
9. Make a pull request targeting the dev branch

Pull requests should be rebased on the latest dev commit and squashed to as few logical commits as possible, preferablyone. Each commit should pass tests without requiring further commits.