├── .flake8 ├── .github └── workflows │ ├── ci.yaml │ └── publish-to-pypi.yaml ├── .gitignore ├── LICENSE.txt ├── README.md ├── bin ├── sg-otio └── sg-otio.py ├── setup.cfg ├── setup.py ├── sg_otio ├── __init__.py ├── adapters │ ├── __init__.py │ ├── cmx_3600.py │ └── shotgrid.py ├── clip_group.py ├── command.py ├── constants.py ├── cut_clip.py ├── cut_diff.py ├── media_cutter.py ├── media_uploader.py ├── plugin_manifest.json ├── sg_cut_reader.py ├── sg_cut_track_writer.py ├── sg_settings.py ├── track_diff.py └── utils.py └── tests ├── __init__.py ├── conftest.py ├── fixtures └── mockgun │ ├── schema.pickle │ └── schema_entity.pickle ├── python ├── __init__.py ├── mock_grid.py └── sg_test.py ├── resources ├── blue.mov ├── blue_frame_5_to_25.xml ├── edls │ ├── 079_HA_006.edl │ ├── 079_HA_V05.edl │ ├── 090PC_091MJ_100TC_V05_TURNOVER_20150123.edl │ ├── 090PC_091MJ_100TC_V06_TURNOVER_20150206.edl │ ├── 20200121_BB_R1_FF3_v2_TEST.edl │ ├── DD_509_LOCKED_VFX_LINK.edl │ ├── ER_00119.edl │ ├── ER_00119_with_comments.edl │ ├── FINALSCHECK_EDL_TEST_140318-2.edl │ ├── FINALSCHECK_EDL_TEST_140318.edl │ ├── HSM_SATL_v001_shotNameNote.edl │ ├── JA_DIEDL_SG_TEST_140212.edl │ ├── R7v26.0_Turnover001_WiP_VFX__1_.edl │ ├── SR001.edl │ ├── SR002.edl │ ├── SR_008.edl │ ├── SR_010.edl │ ├── SR_011.edl │ ├── audio-at-end.edl │ ├── audio-follows-video.edl │ ├── audio-separately.edl │ ├── black_slug_avid1.edl │ ├── black_slug_avid2.edl │ ├── black_slug_fcp.edl │ ├── cut_import_example.edl │ ├── duplicate_cut_items.edl │ ├── jrun_demo_absolute_frames1.edl │ ├── jrun_demo_absolute_frames2.edl │ ├── jrun_demo_relative_frames1.edl │ ├── jrun_demo_relative_frames2.edl │ ├── konmari_relative1.edl │ ├── pxy5.edl │ ├── raphe_temp1_rfe_R01_v01_TRANSITIONS.edl │ └── scan_request_test.edl ├── media_cutter.edl ├── media_cutter.mov ├── media_cutter_prores.mov └── settings.json ├── test_clip_group.py ├── test_command.py ├── test_cut_clip.py ├── test_cut_diff.py ├── test_media_cutter.py ├── test_media_uploader.py ├── test_shotgrid_adapter.py └── test_utils.py /.flake8: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: Apache-2.0 2 | # Copyright Contributors to the SG Otio project 3 | 4 | # Flake 8 PEP and lint configuration - https://gitlab.com/pycqa/flake8 5 | # 6 | # This defines the official lint and PEP8 rules for this repository 7 | # 8 | # You can run this locally by doing pip install flake8 and then 9 | # >flake8 . 10 | 11 | [flake8] 12 | 13 | # Things we don't want to lint 14 | exclude = 15 | .tox, 16 | .git, 17 | .flake8, 18 | .gitignore, 19 | .travis.yml, 20 | .cache, 21 | .eggs, 22 | *.rst, 23 | *.yml, 24 | *.pyc, 25 | *.pyo, 26 | *.egg-info, 27 | __pycache__, 28 | # Those are our third parties, do not lint them 29 | vendors, 30 | # Skip __init__.py files, to not have a lot of 'xxx' imported but unused 31 | python/__init__.py, 32 | python/*/__init__.py, 33 | # Skip the auto-generated ui file. 34 | python/*/ui, 35 | venv, 36 | winenv, 37 | osx_env, 38 | win_env, 39 | 40 | # Ignore some errors 41 | # 42 | # E402 module level import not at top of file 43 | # E501 line too long (112 > 79 characters) 44 | # N802 Variables should be lower case. (clashes with Qt naming conventions) 45 | # N806 Variables should be lower case. (clashes with Qt naming conventions) 46 | # W503 line break before binary operator (it breaks before, not after) 47 | 48 | ignore = E501, E402, N802, N806, W503 49 | 50 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: Apache-2.0 2 | # Copyright Contributors to the SG Otio project 3 | 4 | name: Run tests 5 | 6 | on: 7 | push: 8 | branches: [master] 9 | paths-ignore: 10 | - "*.md" 11 | - "*.in" 12 | - "*.txt" 13 | 14 | pull_request: 15 | branches: [master] 16 | paths-ignore: 17 | - "*.md" 18 | - "*.in" 19 | - "*.txt" 20 | 21 | jobs: 22 | test-sg-otio: 23 | 24 | name: "sg-otio" 25 | strategy: 26 | matrix: 27 | python-version: ['3.9', '3.10', '3.11'] 28 | os: [ubuntu-latest, macos-13] # windows-latest when wheel is in place, macos-latest is now arm64 29 | 30 | runs-on: ${{ matrix.os }} 31 | 32 | env: 33 | OS: ${{ matrix.os }} 34 | PYTHON: ${{ matrix.python-version }} 35 | GH_COV_PY: 3.11 36 | GH_COV_OS: ubuntu-latest 37 | 38 | steps: 39 | - uses: actions/checkout@v2 40 | 41 | - name: Install ffmpeg 42 | uses: FedericoCarboni/setup-ffmpeg@v1 43 | id: setup-ffmpeg 44 | with: 45 | # Not strictly necessary, but it may prevent rate limit 46 | # errors especially on GitHub-hosted macos machines. 47 | token: ${{ secrets.GITHUB_TOKEN }} 48 | 49 | - name: Set up Python ${{ matrix.python-version }} 50 | uses: actions/setup-python@v2 51 | with: 52 | python-version: ${{ matrix.python-version }} 53 | 54 | - name: Install dependencies 55 | run: | 56 | python -m pip install --upgrade pip 57 | pip install git+https://github.com/shotgunsoftware/python-api.git 58 | 59 | - name: Install Package 60 | run: | 61 | pip install -e . 62 | pip install -e .[dev] # Why 2 pip installs? 63 | 64 | - name: Lint with flake8 65 | run: | 66 | flake8 --show-source --statistics --config .flake8 67 | 68 | - name: Test with pytest 69 | run: | 70 | pip install pytest 71 | pip install pytest-cov 72 | pytest -s --cov=./ --cov-report=xml 73 | 74 | - name: Upload coverage to Codecov 75 | if: matrix.python-version == env.GH_COV_PY && matrix.os == env.GH_COV_OS 76 | uses: codecov/codecov-action@v3 77 | with: 78 | token: ${{ secrets.CODECOV_TOKEN }} 79 | flags: unittests 80 | name: sg-otio-codecov 81 | fail_ci_if_error: true 82 | env_vars: OS,PYTHON 83 | 84 | # shell: bash 85 | -------------------------------------------------------------------------------- /.github/workflows/publish-to-pypi.yaml: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: Apache-2.0 2 | # Copyright Contributors to the SG Otio project 3 | 4 | name: Publish to TestPyPi and PyPI 5 | 6 | on: 7 | release: 8 | types: [published] 9 | # Keeping this around, useful when working on this, with just tags 10 | # push: 11 | # tags: 12 | # - "*" 13 | 14 | jobs: 15 | build-n-publish: 16 | name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI 17 | strategy: 18 | matrix: 19 | python-version: [ "3.10"] 20 | os: [ubuntu-latest] 21 | 22 | runs-on: ${{ matrix.os }} 23 | 24 | steps: 25 | - uses: actions/checkout@master 26 | - name: Set up Python ${{ matrix.python-version }} 27 | uses: actions/setup-python@v2 28 | with: 29 | python-version: ${{ matrix.python-version }} 30 | - name: Update pip 31 | run: >- 32 | python -m pip install --upgrade pip 33 | - name: Install dependencies 34 | run: >- 35 | pip install wheel 36 | - name: Build 37 | run: >- 38 | python setup.py bdist_wheel 39 | - name: Publish distribution 📦 to Test PyPI 40 | uses: pypa/gh-action-pypi-publish@release/v1 41 | with: 42 | password: ${{ secrets.PYPI_TEST_API_TOKEN }} 43 | repository_url: https://test.pypi.org/legacy/ 44 | - name: Publish distribution 📦 to PyPI 45 | uses: pypa/gh-action-pypi-publish@release/v1 46 | with: 47 | password: ${{ secrets.PYPI_API_TOKEN }} 48 | 49 | 50 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | SG Otio, an OpenTimelineIO ShotGrid Library 2 | ======= 3 | 4 | [![Run tests](https://github.com/GPLgithub/sg-otio/actions/workflows/ci.yaml/badge.svg)](https://github.com/GPLgithub/sg-otio/actions/workflows/ci.yaml) 5 | 6 | [![codecov](https://codecov.io/gh/GPLgithub/sg-otio/branch/master/graph/badge.svg?token=9X2MDPFCBI)](https://codecov.io/gh/GPLgithub/sg-otio) 7 | 8 | A library to represent [OpenTimelineIO](http://opentimeline.io/) data in [ShotGrid](https://www.shotgrid.com), 9 | and vice versa. 10 | 11 | Disclaimer 12 | ---------- 13 | 14 | SG Otio is currently in Public Alpha. That means that it may be missing 15 | some essential features and there are large changes planned. During this phase 16 | we actively encourage you to provide feedback, requests, comments, and/or 17 | contributions. 18 | 19 | 20 | Installation 21 | ------------ 22 | 23 | ### SG Python API 24 | 25 | The SG Python API is not available on PyPi and must be manually installed 26 | from github, e.g. `pip install git+https://github.com/shotgunsoftware/python-api.git` 27 | 28 | ### ffmpeg 29 | sg-otio requires ffmpeg to be installed, and ffmpeg must be in the `PATH`. 30 | 31 | - Binaries can be downloaded from [FFmpeg download page](https://ffmpeg.org/download.html), in which case the 32 | binaries should be added to the `PATH` environment variable. 33 | - A package manager can be used, for example on MacOS, `brew install ffmpeg`, in 34 | which case the PATH should already be updated by the package manager. 35 | 36 | ### sg-otio package 37 | 38 | SG Otio can be installed from PyPi, e.g. `pip install sg-otio` 39 | 40 | SG Otio can also be installed from sources. 41 | - Get a local copy of this repo: `git clone https://github.com/GPLgithub/sg-otio.git` 42 | - Install it with `pip`: `pip install ./sg-otio` 43 | 44 | sg-otio usage 45 | ------------- 46 | 47 | You can access the help with `sg-otio read --help`, `sg-otio write --help`, or `sg-otio compare --help`. 48 | 49 | ### ShotGrid login information 50 | 51 | You can provide Shotgrid login information in 3 different ways: 52 | - `--login --password ` 53 | - `--script-name