Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 2.11 KB

README.md

File metadata and controls

44 lines (33 loc) · 2.11 KB
Raw

❤ pytemplate

Template for creating new Python tools at Brand New School.

Test status ShotGrid status Version

Developed at Brand New School.

Features

  • Dependency management via poetry.
  • Automated testing.
  • Doubles as cpenv module with automated publishing to ShotGrid.
  • Convenient tasks module to run code-quality checks and tests.

Template Instructions

  1. Create a new repository under nybrandnewschool using this template.
  2. Title: Adjust the title in this README.
  3. Badges: Replace the repository name in each badge.
  4. Description: Replaced the project description above the Features section.
  5. Remove everything below the description in the README. You may choose to include a tool preview image, a list of features, and usage your tool in your new README.
  6. Adjust the metadata in pyproject.toml, module.yml, and __init__.py files including resetting the version number to 0.1.0.

Testing

Tests are run automatically via github actions on push and pull requests. See the repositories actions tab or a pull request to view the test results. You can also run the tests locally using py -m tasks test.

Publishing a new Version to ShotGrid

There is another github workflow set to publish this module to ShotGrid when a new tag is pushed.

  1. Use the version task to increment the package. Use major, minor, or patch following semantic versioning.
    py -m tasks version patch --commit
  1. Use the release task to push a new tag to github and trigger the publish workflow.
    py -m tasks release

You may also publish to ShotGrid manually by using cpenv publish . --to_repo=bns_shotgun.