diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index c286af5..40cbb39 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -4,16 +4,12 @@ on: push: branches: [main] paths-ignore: - - "*.md" - - "*.in" - - "*.txt" + - "**.md" pull_request: branches: [main] paths-ignore: - - "*.md" - - "*.in" - - "*.txt" + - "**.md" jobs: test-plugin: @@ -24,22 +20,15 @@ jobs: matrix: python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] os: [ubuntu-latest, macos-latest, windows-latest] - otio-version: [ "extract_adapters" ] - # TODO Once we have landed extracted adapters we replace otio-version - #otio-version: ["0.15.0", "main"] - # We exclude this combination as it's not supported on all - # platforms at the time of this commit - exclude: - - python-version: "3.11" - otio-version: "0.15.0" + otio-version: ["0.17.0", "main"] runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} @@ -48,10 +37,8 @@ jobs: python -m pip install --upgrade pip if [[ "${{ matrix.otio-version }}" == "main" ]]; then pip install "git+https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git" - elif [[ "${{ matrix.otio-version }}" == "extract_adapters" ]]; then - pip install "git+https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git@${{ matrix.otio-version }}" else - pip install -V OpenTimelineIO==${{ matrix.otio-version }} + pip install OpenTimelineIO>=${{ matrix.otio-version }} --pre --only-binary :all: fi pip install flake8 pytest pytest-cov shell: bash diff --git a/.github/workflows/create_draft_release.yaml b/.github/workflows/create_draft_release.yaml deleted file mode 100644 index 130be3d..0000000 --- a/.github/workflows/create_draft_release.yaml +++ /dev/null @@ -1,33 +0,0 @@ -name: Create draft release - -on: - push: - tags: - - '*' - -jobs: - build: - env: - plugin_name: "otio-ale-adapter" - - name: Create Release - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v2 - - name: Create Release - id: create_release - uses: actions/create-release@v1 - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token - with: - tag_name: ${{ github.ref }} - release_name: otio-template-plugin{{ github.ref }} - body: | - Changes in this release - * something - * something - - Please upgrade your adapter with `pip install --upgrade ${{ env.plugin_name }}` - draft: true - prerelease: false diff --git a/README.md b/README.md index fcf03b4..079399f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # OpenTimelineIO ALE Adapter +[![Build Status](https://github.com/OpenTimelineIO/otio-ale-adapter/actions/workflows/ci.yaml/badge.svg)](https://github.com/OpenTimelineIO/otio-ale-adapter/actions/workflows/ci.yaml) +![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2FOpenTimelineIO%2Fotio-ale-adapter%2Fmain%2F.github%2Fworkflows%2Fci.yaml&query=%24.jobs%5B%22test-plugin%22%5D.strategy.matrix%5B%22otio-version%22%5D&label=OpenTimelineIO) +![Dynamic YAML Badge](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2FOpenTimelineIO%2Fotio-ale-adapter%2Fmain%2F.github%2Fworkflows%2Fci.yaml&query=%24.jobs%5B%22test-plugin%22%5D.strategy.matrix%5B%22python-version%22%5D&label=Python) The `ale` adapter is part of OpenTimelineIO's contrib adapter plugins. + # Adapter Feature Matrix The following features of OTIO are supported by the `ale` adapter: @@ -21,6 +25,13 @@ The following features of OTIO are supported by the `ale` adapter: |Color Decision List | N/A | |Image Sequence Reference | ✖ | +# Adapter specific arguments +The ALE adapter adds a couple of optional arguments to the `read_from_string()` function +>read_from_string(input_str, **fps=24**, **ale_name_column_key='Name'**) + +The ALE adapter adds a couple of optional arguments to the `write_to_string()` function +>write_to_string(input_otio, **columns=None**, **fps=None**, **video_format=None**) + # License OpenTimelineIO and the "ale" adapter are open source software. @@ -29,10 +40,12 @@ Please see the [LICENSE](LICENSE) for details. Nothing in the license file or this project grants any right to use Pixar or any other contributor’s trade names, trademarks, service marks, or product names. -## Contributions +# Contributions If you want to contribute to the project, -please see: https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html +please see: https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html +Please also read up on [testing your code](https://github.com/OpenTimelineIO/otio-plugin-template#testing-your-plugin-during-development) +in the "getting started" section of the OpenTimelineIO plugin template repository. # Contact diff --git a/pyproject.toml b/pyproject.toml index 442bc63..9ff39c4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ license = { file="LICENSE" } readme = "README.md" requires-python = ">=3.7" dependencies = [ - "opentimelineio >= 0.15.0" + "opentimelineio >= 0.17.0.dev1" ] classifiers = [ @@ -31,6 +31,7 @@ classifiers = [ "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", "Operating System :: OS Independent", "Natural Language :: English" ]