Skip to content

otiotool docs #1921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

jminor
Copy link
Collaborator

@jminor jminor commented Aug 15, 2025

The otiotool command line utility has no documentation aside from it's built-in usage statement. This PR adds a documentation page with detailed examples and explanations. This PR also makes a minor improvement to the otiotool command line argument validation & usage statement.

otiotool -i multitrack.otio --flatten video -o output.otio --list-tracks
```

### Stack or Concatenate Timelines
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does ordering of the inputs matter here as well? (for stack and concat)

Copy link
Contributor

@cato-o cato-o Aug 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and in a way flatten too for what's on top of the flatten

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

@codecov-commenter
Copy link

codecov-commenter commented Aug 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.99%. Comparing base (c0e97b0) to head (e8e3044).
⚠️ Report is 64 commits behind head on main.

❌ Your changes status has failed because you have indirect coverage changes. Learn more about Unexpected Coverage Changes and reasons for indirect coverage changes.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1921      +/-   ##
==========================================
+ Coverage   84.11%   84.99%   +0.87%     
==========================================
  Files         198      181      -17     
  Lines       22241    13070    -9171     
  Branches     4687     1206    -3481     
==========================================
- Hits        18709    11109    -7600     
+ Misses       2610     1778     -832     
+ Partials      922      183     -739     
Flag Coverage Δ
py-unittests 84.99% <100.00%> (+0.87%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
...-opentimelineio/opentimelineio/console/otiotool.py 65.72% <100.00%> (-0.59%) ⬇️

... and 138 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1b3ece1...e8e3044. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jminor
Copy link
Collaborator Author

jminor commented Aug 15, 2025

Hmmm.. How do I link to an anchor within a relative page?

/home/runner/work/OpenTimelineIO/OpenTimelineIO/docs/tutorials/otiotool.md:7: WARNING: 'myst' reference target not found: ./quickstart#install-otio]

Signed-off-by: Joshua Minor <[email protected]>

`otiotool` is included with several other command line utilities as part of the
OpenTimelineIO Python module. You can install it via typical Python utilities
like `pip`, etc. See [Quickstart](./quickstart]) for details.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
like `pip`, etc. See [Quickstart](./quickstart]) for details.
like `pip`, etc. See [Quickstart](./quickstart) for details.

I think this will fix the issue with the invalid link. If it doesn't, try [Quickstart](quickstart).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants