Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.98 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.98 KB

Pyblish Mindbender

Build Status Coverage Status PyPI version

A basic asset creation pipeline - batteries included.

temp

Install

$ pip install pyblish-mindbender

Usage

>>> from pyblish_mindbender import api, maya
>>> api.install(maya)

Testing

cd pyblish-mindbender
docker build -t pyblish/mindbender -f Dockerfile-maya2016 .

# Run nosetests (Linux/OSX)
docker run --rm -v $(pwd):/repo pyblish/mindbender

Code convention

Below are some of the standard practices applied to this repositories.

  • PEP8
    • All code is written in PEP8. It is recommended you use a linter as you work, flake8 and pylinter are both good options.
  • Napoleon docstrings
    • Any docstrings are made in Google Napoleon format. See Napoleon for details.
  • Semantic Versioning
  • Underscore means private
    • Anything prefixed with an underscore means that it is internal to wherever it is used. For example, a variable name is only ever used in the parent function or class. A module is not for use by the end-user. In contrast, anything without an underscore is public, but not necessarily part of the API. Members of the API resides in api.py.