Repo improvements

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,45 @@
+---
+name: Bug report
+about: Problem or regression with an existing feature
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+Before opening a bug report, please search open and closed issues to see if the problem has already been addressed. If there is such a report, and your issue is not adequately addressed there, please reference the issues in your new report.
+
+## Bug Report
+
+Please pick one of the following categories:
+
+### Build Problem
+
+Please provide your complete command line invocation, and attach a log of the console output.
+
+### Incorrect Functionality and General Questions
+
+Describe the issue here.
+
+## To Reproduce
+
+1. Operating System
+2. Python version
+3. Example snippet that demonstrates the issue - if it's a build issue,
+4. OpenTimelineIO release version or commit hash
+
+## Expected Behavior
+
+Description of the expected behavior.
+
+## Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+## Logs
+
+If applicable, attach a complete console log, that show a reproduction of the problem entirely.
+
+## Additional Context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest a new feature for otio-aaf-adapter
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Feature Request
+
+Is this a New Feature, or a Proposed Change to existing Behavior?
+
+## Description
+
+Describe the new feature, or describe the modification to existing behavior, and provide context as necessary to help with understanding how the feature relates to a workflow or functionality.
+
+## Context
+
+Add any other context here, such as simulated output, or screenshots, that might help clarify the request.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+**Link the Issue(s) this Pull Request is related to.**
+
+Each PR should link at least one issue, in the form:
+
+Fixes #123
+
+Use one line for each Issue. This allows auto-closing the related issue when the fix is merged.
+
+**Summarize your change.**
+
+Describe the reason for the change.
+
+Add a list of changes, and note any that might need special attention during review.
+
+**Reference associated tests.**
+
+If no new tests are introduced as part of this PR, note the tests that are providing coverage.
+
+<!--
+Important: If this is your first contribution to OpenTimelineIO, you will need to submit a Contributor License Agreement. For a step-by-step instructions on the pull request process, see
+https://github.com/AcademySoftwareFoundation/OpenTimelineIO/tree/main/CONTRIBUTING.md
+-->

.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      day: "monday"
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -1,5 +1,10 @@
 name: Run tests
 
+env:
+  GH_COV_PY: 3.7
+  GH_COV_OS: ubuntu-latest
+  GH_DEPENDABOT: dependabot
+
 on:
   push:
     branches: [main]
@@ -84,7 +89,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pytest pytest-cov wheel -V pyaaf2==1.4.0
-        pip install git+https://github.com/markreidvfx/OpenTimelineIO@remove_aaf_adapter_v1
+        pip install git+https://github.com/AcademySoftwareFoundation/OpenTimelineIO.git@refs/pull/1348/head
         # pip install pytest pytest-cov -V pyaaf2==1.4.0 -V OpenTimelineIO==0.14.1
 
     - name: Run Unit Tests
@@ -93,6 +98,14 @@ jobs:
         python -m pip install dist/*.whl --no-index
         pytest -v tests
 
+    - name: Upload coverage to Codecov
+      if: matrix.python-version == env.GH_COV_PY && matrix.os == env.GH_COV_OS && github.actor != env.GH_DEPENDABOT
+      uses: codecov/codecov-action@v3
+      with:
+        flags: unittests
+        name: otio-aaf-adapter-codecov
+        fail_ci_if_error: true
+
   latest-release:
     needs: test-otio-git
     runs-on: ubuntu-latest

CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+https://github.com/AcademySoftwareFoundation/OpenTimelineIO/blob/main/CODE_OF_CONDUCT.md

CONTRIBUTING.md

@@ -0,0 +1 @@
+https://github.com/AcademySoftwareFoundation/OpenTimelineIO/blob/main/CONTRIBUTING.md

CONTRIBUTORS.md

@@ -0,0 +1,21 @@
+This plugin is part of the OpenTimelineIO project, whose contributors are
+listed at this URL:
+https://github.com/AcademySoftwareFoundation/OpenTimelineIO/blob/main/CONTRIBUTORS.md
+
+This is a list of people who have contributed code to the
+otio-aaf-adapter project, sorted alphabetically by first name.
+
+If you know of anyone missing from this list, please contact us:
+https://lists.aswf.io/g/otio-discussion
+
+* Andrew Moore ([andrewmoore-nz](https://github.com/andrewmoore-nz))
+* Eric Reinecke ([reinecke](https://github.com/reinecke))
+* Freeson Wang ([freesonluxo](https://github.com/freesonluxo))
+* Josh Burnell ([JoshBurnell](https://github.com/JoshBurnell))
+* Joshua Minor ([jminor](https://github.com/jminor))
+* Julian Yu-Chung Chen ([jchen9](https://github.com/jchen9))
+* Mark Reid ([markreidvfx](https://github.com/markreidvfx))
+* Shahbaz Khan ([shahbazk8194](https://github.com/shahbazk8194))
+* Stefan Schulze ([stefanschulze](https://github.com/stefanschulze))
+* Stephan Steinbach ([ssteinbach](https://github.com/ssteinbach))
+* Tim Lehr ([timlehr](https://github.com/timlehr))

README.md

@@ -1,13 +1,15 @@
-OpenTimelineIO Advanced Authoring Format (AAF) Adapter
-=====================================
+# OpenTimelineIO Advanced Authoring Format (AAF) Adapter
 
 [![Supported VFX Platform Versions](https://img.shields.io/badge/vfx%20platform-2018--2021-lightgrey.svg)](http://www.vfxplatform.com/)
 ![Supported Versions](https://img.shields.io/badge/python-2.7%2C%203.7%2C%203.8%2C%203.9%2C%203.10-blue)
-[![Run tests](https://github.com/markreidvfx/otio-aaf-adapter/actions/workflows/ci.yaml/badge.svg)](https://github.com/markreidvfx/otio-aaf-adapter/actions/workflows/ci.yaml)
+[![Run tests](https://github.com/markreidvfx/otio-aaf-adapter/actions/workflows/ci.yaml/badge.svg)](https://github.com/OpenTimelineIO/otio-aaf-adapter/actions/workflows/ci.yaml)
 
+## Overview
 
-Feature Matrix
---------------
+This project is a [OpenTimelineIO](https://github.com/AcademySoftwareFoundation/OpenTimelineIO) adapter for reading and writing Advanced Authoring Format (AAF) files.
+This adapter was originally included with OpenTimelineIO as a contrib adapter. It is in the process of being separated into this project to improve maintainability and reduced the dependencies of both projects.
+
+## Feature Matrix
 
 | Feature                  | Read  | Write |
 | -------                  | ----  | ----- |
@@ -24,10 +26,17 @@ Feature Matrix
 | Color Decision List      |  ✖   |   ✖   |
 | Image Sequence Reference |  ✖   |   ✖   |
 
+## Requirements
+
+* [OpenTimelineIO](https://github.com/AcademySoftwareFoundation/OpenTimelineIO)
+* [pyaaf2](https://github.com/markreidvfx/pyaaf2)
+
+
+## Licensing
 
+This repository is licensed under the [Apache License, Version 2.0](LICENSE.md).
 
-Testing for Development
------------------------
+## Testing for Development
 
 ```bash
 # In the root folder of the repo
@@ -36,3 +45,14 @@ pip install -e .
 # Test adapter
 otioconvert -i some_timeline.aaf -o some_timeline.ext
 ```
+
+If you are using a version of OpentimelineIO that still has the AAF contrib adapter you may need to add the path of [plugin_manifest.json](./src/otio_aaf_adapter/plugin_manifest.json) to your `OTIO_PLUGIN_MANIFEST_PATH` [environment variable.](https://opentimelineio.readthedocs.io/en/latest/tutorials/otio-env-variables.html) This should override the contrib version.
+
+## Contributions
+
+If you have any suggested changes to the otio-aaf-adapter,
+please provide them via [pull request](../../pulls) or [create an issue](../../issues) as appropriate.
+
+All contributions to this repository must align with the contribution
+[guidelines](https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html)
+of the OpenTimelineIO project.

codecov.yml

@@ -0,0 +1,2 @@
+fixes:
+  - "*/site-packages/::src/"

docs/requirements.txt

@@ -1,4 +1,4 @@
-sphinx==4.5.0
-readthedocs-sphinx-ext==2.1.5 # ??
+sphinx==5.1.1
+readthedocs-sphinx-ext==2.1.8
 sphinx-rtd-theme
-myst-parser==0.17.2
+myst-parser==0.18.0

setup.cfg

@@ -23,7 +23,7 @@ ignore =
     W504
 
 [tool:pytest]
-addopts = --cov=./ -W ignore::DeprecationWarning
+addopts = --cov=otio_aaf_adapter
 
 [bdist_wheel]
 # Let a wheel be compatible with both Python 2 and 3

tests/test_aaf_adapter.py

@@ -16,6 +16,9 @@
     AAFValidationError
 )
 
+# module needs to be imported for code coverage to work
+import otio_aaf_adapter.adapters.advanced_authoring_format  # noqa: F401
+
 try:
     # python2
     import StringIO as io