PrEditor 2.0.0__tar.gz

preditor-2.0.0/.coveragerc

@@ -0,0 +1,17 @@
+[report]
+show_missing = false
+skip_covered = true
+skip_empty = true
+
+[run]
+# Ensure all python modules in preditor have their coverage reported,
+# not just files that pytest touches.
+source = preditor
+omit =
+    */site-packages/*
+    tests/*
+    # This file is automatically generated by setuptools_scm
+    preditor/version.py
+parallel=True
+relative_files=True
+data_file=.coverage/.coverage

preditor-2.0.0/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,45 @@
+---
+name: Bug Report
+about: File a bug report. (Please search exisiting issues before submitting. Also see CONTRIBUTING.md.)
+title: ""
+labels: bug
+assignees: ""
+---
+
+## Summary
+
+<!--
+    What went wrong? What is the current behavior?
+    Please be as clear and concise as possible.
+-->
+
+## Expected Behavior
+
+<!--
+    What did you expect to happen?
+-->
+
+## Steps to Reproduce Behavior
+
+<!--
+    If possible, please share the steps to reproduce the issue.
+    If relevant, feel free to include any code that reliably reproduces the issue.
+-->
+
+### Solution
+
+<!--
+    If you have any suggestions on fixing the issue.
+-->
+
+## Environment
+
+- Version: <!-- [e.g. 0.1.0] -->
+- OS and Python version: <!-- [e.g. Linux/Python 3.8.7] -->
+
+## Additional Context
+
+<!--
+    Append any additional context regarding the problem here.
+    Screenshots are always welcome!
+-->

preditor-2.0.0/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,28 @@
+---
+name: Feature Request
+about: Suggest an idea for the project. (Please search exisiting issues before submitting. Also see CONTRIBUTING.md.)
+title: ""
+labels: enhancement
+assignees: ""
+---
+
+
+## Description
+
+<!--
+    Describe the functionality you would like to see added the project.
+    Please be as clear and concise as possible.
+-->
+
+## Solution
+
+<!--
+    Describe what a possible solution would look and/or act like.
+-->
+
+## Additional Context
+
+<!--
+    Append any additional context regarding the request here.
+    Screenshots are always welcome!
+-->

preditor-2.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,29 @@
+## Checklist
+
+<!--
+    Place an `x` in the boxes you have addressed. You can also fill these out after creating the Pull Request. If you're unsure about any of them, don't hesitate to ask. This is simply a reminder of what we are going to look for before merging your code.
+-->
+
+- [ ] I have read the [CONTRIBUTING.md](../CONTRIBUTING.md) document
+- [ ] I formatted my changes with [black](https://github.com/psf/black)
+- [ ] I linted my changes with [flake8](https://github.com/PyCQA/flake8)
+- [ ] I have added documentation regarding my changes where necessary
+- [ ] Any pre-existing tests continue to pass
+- [ ] Additional tests were made covering my changes
+
+## Types of Changes
+
+<!--
+    Place an `x` in the box that applies.
+-->
+
+- [ ] Bugfix (change that fixes an issue)
+- [ ] New Feature (change that adds functionality)
+- [ ] Documentation Update (if none of the other choices apply)
+
+## Proposed Changes
+
+<!--
+    Describe the big picture of your changes here to communicate to why this pull request has been made and should be accepted.
+    If it fixes a bug or resolves a feature request, please be sure to link to that issue.
+-->

preditor-2.0.0/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: PyPi Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade build setuptools wheel twine
+
+      - name: Build wheel
+        run: |
+          python -m build --wheel --sdist
+
+      # Upload the built pip packages so we can inspect them
+      - name: Upload packages.
+        uses: actions/upload-artifact@v4
+        with:
+          name: pip-packages
+          path: |
+            dist/preditor-*.whl
+            dist/preditor-*.tar.gz
+          # This is only used if there is a problem with the next step
+          retention-days: 1
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          twine upload --verbose dist/*

preditor-2.0.0/.github/workflows/static-analysis-and-test.yml

@@ -0,0 +1,185 @@
+name: Static Analysis & Test
+
+on: [push, pull_request]
+
+jobs:
+
+  static-analysis:
+    # We want to run on external PRs, but not on our own internal PRs as they'll
+    # be run by the push to the branch. Without this if check, checks are
+    # duplicated since internal PRs match both the push and pull_request events.
+    # https://github.com/psf/black/blob/f51e53726b39a177355a7917c91c56f390dda7ef/.github/workflows/lint.yml#L7-L12
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox coverage[toml]
+
+      - name: Lint with flake8
+        run: tox -e flake8
+
+      - name: Format with black
+        run: tox -e black
+
+
+  test:
+    # We want to run on external PRs, but not on our own internal PRs as they'll
+    # be run by the push to the branch. Without this if check, checks are
+    # duplicated since internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'windows-latest']
+        python: ['3.8', '3.9', '3.10', '3.11']
+        # Works around the depreciation of python 3.7 for ubuntu
+        # https://github.com/actions/setup-python/issues/544
+        include:
+          - os: 'ubuntu-22.04'
+            python: '3.7'
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox
+
+      - name: Run Tox
+        run: |
+          tox -e begin,py -- --tb short
+
+      - name: Upload coverage
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-${{ matrix.python }}
+          path: .coverage/*
+          include-hidden-files: true
+          retention-days: 1
+
+  coverage:
+    # We want to run on external PRs, but not on our own internal PRs as they'll
+    # be run by the push to the branch. Without this if check, checks are
+    # duplicated since internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    needs: test
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install tox coverage[toml]
+
+      # Ensure version.py is created so coverage can read it's source
+      - name: Run begin
+        run: |
+          tox -e begin
+
+      - name: Download coverage artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: .coverage/
+          pattern: coverage-*
+          merge-multiple: true
+
+      # Tox runs `coverage combine` and `coverage xml`
+      - name: Combine coverage and report
+        run: |
+          tox -e end
+
+          # Report and write to summary.
+          python -m coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+          # Write html coverage report to upload as an artifact
+          python -m coverage html
+
+          # # Report again and fail if under 100%.
+          # python -m coverage report --fail-under=100
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+          # # TODO: If we get 100% coverage we can re-enable this and the
+          # # `--fail-under` check so pull requests fail if the dev doesn't
+          # # add tests for new code.
+          # if: ${{ failure() }}
+
+
+  pip-package:
+    # We want to run on external PRs, but not on our own internal PRs as they'll
+    # be run by the push to the branch. Without this if check, checks are
+    # duplicated since internal PRs match both the push and pull_request events.
+    if:
+      github.event_name == 'push' ||
+      github.event.pull_request.head.repo.full_name != github.repository
+
+    # Build and upload pip packages as artifacts so we can inspect them and
+    # ensure they are correct for actual release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade build setuptools wheel twine
+
+      - name: Build wheel
+        run: |
+          python -m build --wheel --sdist
+
+      - name: Upload packages.
+        uses: actions/upload-artifact@v4
+        with:
+          name: pip-packages
+          path: |
+            dist/preditor-*.whl
+            dist/preditor-*.tar.gz

preditor-2.0.0/.gitignore

@@ -0,0 +1,35 @@
+*.pyc
+*.pyo
+*.rej
+*.swp
+.DS_Store
+
+/.project
+/.pydevproject
+*.egg-info
+.eggs/
+/build/
+/dist/
+/venv/
+*.sublime-*
+pip-wheel-metadata
+
+# Ignore the majority of the docs folder
+/docs/*
+!/docs/
+/docs/source/*
+!/docs/source/
+!/docs/source/conf.py
+!/docs/source/index.rst
+
+# Used by the ci
+.cache/
+downloads/
+shared-venv/
+.tox/
+
+# /preditor
+/preditor/version.py
+
+# Coverage
+.coverage

preditor-2.0.0/.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+---
+ci:
+  autoupdate_schedule: quarterly
+  skip: [black, flake8]
+
+repos:
+
+-   repo: https://github.com/psf/black
+    rev: 22.12.0
+    hooks:
+    -   id: black
+
+-   repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+    -   id: flake8
+        additional_dependencies:
+            - flake8-bugbear==22.12.6
+            - Flake8-pyproject
+            - pep8-naming==0.13.3
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+        exclude: ^(tests/find_files/)
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: isort (python)

preditor-2.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,44 @@
+# Code of Conduct
+
+Those who participate and/or contribute to projects maintained by Blur Studio are expected to treat one another with respect.
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the open source team at opensource@blur.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from [Contributor Covenant](https://www.contributor-covenant.org).

preditor-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing to Blur Projects
+
+We at Blur are excited to contribute to the Visual Effects community by open sourcing our internal projects. We welcome others to integrate these projects into their pipelines and contribute to them as they deem fit via bug reports, feature suggestions, and pull requests.
+
+<!-- MarkdownTOC -->
+
+- [Code of Conduct](#code-of-conduct)
+- [How to Contribute](#how-to-contribute)
+    - [Reporting Issues / Bugs](#reporting-issues--bugs)
+    - [Suggesting a Feature](#suggesting-a-feature)
+    - [Submitting a Pull Request](#submitting-a-pull-request)
+- [Coding Style & Formatting](#coding-style--formatting)
+- [Creating a Release](#creating-a-release)
+
+<!-- /MarkdownTOC -->
+
+## Code of Conduct
+
+Before contributing we recommend checking out our _[code of conduct]_. Thanks! :smile:
+
+## How to Contribute
+
+### Reporting Issues / Bugs
+
+- Double check that the bug has not already been reported by searching the project's GitHub [Issues].
+    - If an issue already exists, you're welcome to add additional context that may not already be present in the original message via the comments.
+- Once you have verified no pre-existing bug report exists, [create a new issue].
+    - Provide a title and concise description.
+    - Include as much detailed information regarding the problem as possible.
+    - Supply reproducible steps that demonstrate the behavior.
+
+### Suggesting a Feature
+
+- Double check that a similar request has not already been made by searching the project's GitHub [Issues].
+- If no issue exists pertaining to your feature request, [create a new issue].
+    - Provide a title and concise description.
+    - Describe what functionality is missing and why it would be useful for yourself and others.
+    - If relevant, include any screenshots, animated GIFs, or sketches that might further demonstrate the desired feature.
+
+### Submitting a Pull Request
+
+1. Fork the Project
+2. Create your Branch (`git checkout -b my-amazing-feature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+    - Be sure to follow our coding style and formatting conventions (below).
+4. Push to the Branch (`git push origin my-amazing-feature`)
+5. Open a Pull Request
+    - List what you've done.
+    - Link to any related or addressed issues or feature requests.
+
+## Coding Style & Formatting
+
+In order to streamline reviews and reduce the barrier-to-entry for developers, we've adopted several standardized tools and workflows to maintain a consistent and reliable code appearance.
+
+A set of GitHub Action workflows are in place to perform the following style and formatting checks against every push to our project repositories. These checks must successfully pass before a pull request can be accepted.
+
+**Styling**
+
+Styling or linting is performed via [flake8] along with the plugins [flake8-bugbear], [Flake8-pyproject] & [pep8-naming]. A minor amount of configuration has been added to _[pyproject.toml]_ in order to provide better compatibility with our formatter black (see next section).
+
+**Formatting**
+
+Code formatting is completed by [black]. By relinquishing code appearance standards to Black we manage to greatly reduce semantic arguments/discussions that might distract from progress on a project.
+
+
+## Creating a Release
+
+Releases are made manually by project managers and will automatically be uploaded to PyPI (via GitHib Action workflow) once completed.
+
+[flake8]: https://github.com/PyCQA/flake8
+[flake8-bugbear]: https://github.com/PyCQA/flake8-bugbear
+[Flake8-pyproject]: https://github.com/john-hen/Flake8-pyproject
+[pep8-naming]: https://github.com/PyCQA/pep8-naming
+[pyproject.toml]: https://github.com/blurstudio/hab/blob/master/pyproject.toml
+[black]: https://github.com/psf/black
+[Issues]: https://github.com/blurstudio/preditor/issues
+[create a new issue]: https://github.com/blurstudio/preditor/issues/new
+[code of conduct]: https://github.com/blurstudio/preditor/blob/master/CODE_OF_CONDUCT.md