README.md

Maya Python Project Template

A GitHub template for Maya Python tools
Report Bug · Request Feature

Example project built using this template can be found here.

HOW TO USE THIS TEMPLATE

DO NOT FORK this is meant to be used from Use this template feature.

1. Click on Use this template button.
2. Give a name and description to the new project (e.g. my_awesome_project, please use all lowercase and underscores separation for repo names).
3. GitHub Actions will process the template and commit to the new repo, this may take a few minutes. Check the progress in the Actions tab of the new repository.
4. Once setup is complete, clone the new project and start coding!

NOTE: WAIT until first CI run on GitHub actions before cloning the new project. This will be kicked off automatically after creating the new repo from the template, and should take a couple of minutes to complete.

What is included in this template?

• Basic project structure.
• README.md and CONTRIBUTING templates.
• Bug report and feature request templates.
• Continuous integration using GitHub Actions with jobs to:
  • Run integration tests across a range of Maya versions in isolated Docker containers.
    • Note: You should hold a valid Maya license.
  • Enforce coding standards with pylint, black, and mypy.
  • Build and deploy documentation to GitHub pages with mkdocs.
  • Automated releases using Python Semantic Versioning (optional).

Acknowledgments

• This project uses Docker images courtesy of mottosso/docker-maya.
• Inspiration taken from both:
  • python-project-template.
  • Best-README-Template.