konbinine 0.1.2

Opinionated Autodesk Shotgun/ShotGrid API Wrapper.

konbini

おまえはもうショットいる。なに？！

Opinionated wrapper for Autodesk Shotgun I mean ShotGrid Python API because the API usage requirements is 便利じゃないでしょう？

コンビニね～ As there is an existing PyPI project using konbini name, this repo project name on PyPI will be konbinine.

How to Use

For Python 3.7 and newer! While Autodesk made shotgun_api3 to be compatible with Python 2 and 3, konbinine uses dataclass that is only available in Python 3.7 onwards.

konbinine is designed to be use with web framework (such as Django, Flask, etc) that interacts with ShotGrid. This library has not been tested inside Digital Content Creation (DCC) software such as Maya, 3ds Max or Houdini.

Technically it should just work but that is outside the scope of this library.

New Project

1. Add konbinine to your project's requirements.txt.
2. ???
3. Profit (in improving code readability and debugging)

Existing Project that Uses shotgun_api3

You will need to... rewrite/refactor your code to use konbinine! Pretty much the main reason why konbinine was created is to improve the Developer Experience (DX) when interacting with ShotGrid.

Quickstart for Developers

pip install -r requirements.txt

Extending konbinine

Coming soon!