Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-25 21:32:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added basic documentation for new custom provider

Browse source
This commit is contained in:
Petr Kalis 2021-11-26 17:52:59 +01:00
parent e84eff3963
commit 216601a015
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
openpype/modules/default_modules/sync_server/README.md
View file

@ -56,6 +56,13 @@ representation.files.sites:
`db.getCollection('MY_PROJECT').update({type:"representation"},
{$set:{"files.$[].sites.MY_CONFIGURED_REMOTE_SITE" : {}}}, true, true)`
I want to create new custom provider:
-----------------------------------
- take `providers\abstract_provider.py` as a base class
- create provider class in `providers` with a name according to a provider (eg. 'gdrive.py' for gdrive provider etc.)
- upload provider icon in png format, 24x24, into `providers\resources`, its name must follow name of provider (eg. 'gdrive.png' for gdrive provider)
- register new provider into `providers.lib.py`, test how many files could be manipulated at same time, check provider's API for limits
Needed configuration:
--------------------
`pype/settings/defaults/project_settings/global.json`.`sync_server`: