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

work on sphinx

Browse source
This commit is contained in:
Ondrej Samohel 2020-10-09 16:05:14 +02:00
parent f9c9214e35
commit da3c0d73f4
No known key found for this signature in database
GPG key ID: 8A29C663C672C2B7
105 changed files with 3112 additions and 1022 deletions
Download patch file Download diff file Expand all files Collapse all files

3
conftest.py
View file

@ -0,0 +1,3 @@
# -*- coding: utf-8 -*-
"""Conftest."""
...

25
docs/source/conf.py
View file

@ -14,22 +14,15 @@
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
from pypeapp.pypeLauncher import PypeLauncher
from pypeapp.deployment import Deployment
pype_setup = os.getenv('PYPE_SETUP_PATH')
d = Deployment(pype_setup)
launcher = PypeLauncher()
tools, config_path = d.get_environment_data()
os.environ['PYPE_CONFIG'] = config_path
os.environ['TOOL_ENV'] = os.path.normpath(os.path.join(config_path,
'environments'))
launcher._add_modules()
launcher._load_default_environments(tools=tools)
import sys
pype_root = os.path.abspath('../..')
sys.path.insert(0, pype_root)
repos = os.listdir(os.path.abspath("../../repos"))
repos = [os.path.join(pype_root, "repos", repo) for repo in repos]
for repo in repos:
sys.path.append(repo)
# -- Project information -----------------------------------------------------
@ -210,7 +203,7 @@ epub_exclude_files = ['search.html']
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {'https://docs.python.org/3/': None}
# -- Options for todo extension ----------------------------------------------

42
docs/source/igniter.rst Normal file
View file

@ -0,0 +1,42 @@
igniter package
===============
.. automodule:: igniter
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
igniter.bootstrap\_repos module
-------------------------------
.. automodule:: igniter.bootstrap_repos
:members:
:undoc-members:
:show-inheritance:
igniter.install\_dialog module
------------------------------
.. automodule:: igniter.install_dialog
:members:
:undoc-members:
:show-inheritance:
igniter.install\_thread module
------------------------------
.. automodule:: igniter.install_thread
:members:
:undoc-members:
:show-inheritance:
igniter.tools module
--------------------
.. automodule:: igniter.tools
:members:
:undoc-members:
:show-inheritance:

5
docs/source/modules.rst
View file

@ -1,7 +1,8 @@
pype
====
igniter
=======
.. toctree::
:maxdepth: 6
igniter
pype

20
docs/source/pype.aport.rst
View file

@ -1,20 +0,0 @@
pype.aport package
==================
.. automodule:: pype.aport
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.aport.api module
---------------------
.. automodule:: pype.aport.api
:members:
:undoc-members:
:show-inheritance:

20
docs/source/pype.avalon_apps.rst
View file

@ -1,20 +0,0 @@
pype.avalon\_apps package
=========================
.. automodule:: pype.avalon_apps
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.avalon\_apps.avalon\_app module
------------------------------------
.. automodule:: pype.avalon_apps.avalon_app
:members:
:undoc-members:
:show-inheritance:

36
docs/source/pype.clockify.rst
View file

@ -1,36 +0,0 @@
pype.clockify package
=====================
.. automodule:: pype.clockify
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.clockify.clockify module
-----------------------------
.. automodule:: pype.clockify.clockify
:members:
:undoc-members:
:show-inheritance:
pype.clockify.clockify\_api module
----------------------------------
.. automodule:: pype.clockify.clockify_api
:members:
:undoc-members:
:show-inheritance:
pype.clockify.widget\_settings module
-------------------------------------
.. automodule:: pype.clockify.widget_settings
:members:
:undoc-members:
:show-inheritance:

36
docs/source/pype.ftrack.ftrack_server.rst
View file

@ -1,36 +0,0 @@
pype.ftrack.ftrack\_server package
==================================
.. automodule:: pype.ftrack.ftrack_server
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.ftrack.ftrack\_server.event\_server module
-----------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.event_server
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_server.event\_server\_cli module
----------------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.event_server_cli
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_server.ftrack\_server module
------------------------------------------------
.. automodule:: pype.ftrack.ftrack_server.ftrack_server
:members:
:undoc-members:
:show-inheritance:

52
docs/source/pype.ftrack.lib.rst
View file

@ -1,52 +0,0 @@
pype.ftrack.lib package
=======================
.. automodule:: pype.ftrack.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.ftrack.lib.avalon\_sync module
-----------------------------------
.. automodule:: pype.ftrack.lib.avalon_sync
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_action\_handler module
----------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_action_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_app\_handler module
-------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_app_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_base\_handler module
--------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_base_handler
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.lib.ftrack\_event\_handler module
---------------------------------------------
.. automodule:: pype.ftrack.lib.ftrack_event_handler
:members:
:undoc-members:
:show-inheritance:

52
docs/source/pype.ftrack.rst
View file

@ -1,52 +0,0 @@
pype.ftrack package
===================
.. automodule:: pype.ftrack
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.ftrack.ftrack_server
pype.ftrack.lib
Submodules
----------
pype.ftrack.credentials module
------------------------------
.. automodule:: pype.ftrack.credentials
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.ftrack\_module module
---------------------------------
.. automodule:: pype.ftrack.ftrack_module
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.login\_dialog module
--------------------------------
.. automodule:: pype.ftrack.login_dialog
:members:
:undoc-members:
:show-inheritance:
pype.ftrack.login\_tools module
-------------------------------
.. automodule:: pype.ftrack.login_tools
:members:
:undoc-members:
:show-inheritance:

27
docs/source/pype.fusion.rst
View file

@ -1,27 +0,0 @@
pype.fusion package
===================
.. automodule:: pype.fusion
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.fusion.scripts
Submodules
----------
pype.fusion.lib module
----------------------
.. automodule:: pype.fusion.lib
:members:
:undoc-members:
:show-inheritance:

28
docs/source/pype.fusion.scripts.rst
View file

@ -1,28 +0,0 @@
pype.fusion.scripts package
===========================
.. automodule:: pype.fusion.scripts
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.fusion.scripts.fusion\_switch\_shot module
-----------------------------------------------
.. automodule:: pype.fusion.scripts.fusion_switch_shot
:members:
:undoc-members:
:show-inheritance:
pype.fusion.scripts.publish\_filesequence module
------------------------------------------------
.. automodule:: pype.fusion.scripts.publish_filesequence
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.hosts.blender.rst Normal file
View file

@ -0,0 +1,26 @@
pype.hosts.blender package
==========================
.. automodule:: pype.hosts.blender
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.blender.action module
--------------------------------
.. automodule:: pype.hosts.blender.action
:members:
:undoc-members:
:show-inheritance:
pype.hosts.blender.plugin module
--------------------------------
.. automodule:: pype.hosts.blender.plugin
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.hosts.celaction.rst Normal file
View file

@ -0,0 +1,18 @@
pype.hosts.celaction package
============================
.. automodule:: pype.hosts.celaction
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.celaction.cli module
-------------------------------
.. automodule:: pype.hosts.celaction.cli
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.hosts.fusion.rst Normal file
View file

@ -0,0 +1,26 @@
pype.hosts.fusion package
=========================
.. automodule:: pype.hosts.fusion
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.hosts.fusion.scripts
Submodules
----------
pype.hosts.fusion.lib module
----------------------------
.. automodule:: pype.hosts.fusion.lib
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.hosts.fusion.scripts.rst Normal file
View file

@ -0,0 +1,26 @@
pype.hosts.fusion.scripts package
=================================
.. automodule:: pype.hosts.fusion.scripts
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.fusion.scripts.fusion\_switch\_shot module
-----------------------------------------------------
.. automodule:: pype.hosts.fusion.scripts.fusion_switch_shot
:members:
:undoc-members:
:show-inheritance:
pype.hosts.fusion.scripts.publish\_filesequence module
------------------------------------------------------
.. automodule:: pype.hosts.fusion.scripts.publish_filesequence
:members:
:undoc-members:
:show-inheritance:

7
docs/source/pype.hosts.harmony.rst Normal file
View file

@ -0,0 +1,7 @@
pype.hosts.harmony package
==========================
.. automodule:: pype.hosts.harmony
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.hosts.houdini.rst Normal file
View file

@ -0,0 +1,18 @@
pype.hosts.houdini package
==========================
.. automodule:: pype.hosts.houdini
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.houdini.lib module
-----------------------------
.. automodule:: pype.hosts.houdini.lib
:members:
:undoc-members:
:show-inheritance:

58
docs/source/pype.hosts.maya.rst Normal file
View file

@ -0,0 +1,58 @@
pype.hosts.maya package
=======================
.. automodule:: pype.hosts.maya
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.maya.action module
-----------------------------
.. automodule:: pype.hosts.maya.action
:members:
:undoc-members:
:show-inheritance:
pype.hosts.maya.customize module
--------------------------------
.. automodule:: pype.hosts.maya.customize
:members:
:undoc-members:
:show-inheritance:
pype.hosts.maya.expected\_files module
--------------------------------------
.. automodule:: pype.hosts.maya.expected_files
:members:
:undoc-members:
:show-inheritance:
pype.hosts.maya.lib module
--------------------------
.. automodule:: pype.hosts.maya.lib
:members:
:undoc-members:
:show-inheritance:
pype.hosts.maya.menu module
---------------------------
.. automodule:: pype.hosts.maya.menu
:members:
:undoc-members:
:show-inheritance:
pype.hosts.maya.plugin module
-----------------------------
.. automodule:: pype.hosts.maya.plugin
:members:
:undoc-members:
:show-inheritance:

58
docs/source/pype.hosts.nuke.rst Normal file
View file

@ -0,0 +1,58 @@
pype.hosts.nuke package
=======================
.. automodule:: pype.hosts.nuke
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.nuke.actions module
------------------------------
.. automodule:: pype.hosts.nuke.actions
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nuke.lib module
--------------------------
.. automodule:: pype.hosts.nuke.lib
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nuke.menu module
---------------------------
.. automodule:: pype.hosts.nuke.menu
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nuke.plugin module
-----------------------------
.. automodule:: pype.hosts.nuke.plugin
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nuke.presets module
------------------------------
.. automodule:: pype.hosts.nuke.presets
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nuke.utils module
----------------------------
.. automodule:: pype.hosts.nuke.utils
:members:
:undoc-members:
:show-inheritance:

50
docs/source/pype.hosts.nukestudio.rst Normal file
View file

@ -0,0 +1,50 @@
pype.hosts.nukestudio package
=============================
.. automodule:: pype.hosts.nukestudio
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.nukestudio.events module
-----------------------------------
.. automodule:: pype.hosts.nukestudio.events
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nukestudio.lib module
--------------------------------
.. automodule:: pype.hosts.nukestudio.lib
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nukestudio.menu module
---------------------------------
.. automodule:: pype.hosts.nukestudio.menu
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nukestudio.tags module
---------------------------------
.. automodule:: pype.hosts.nukestudio.tags
:members:
:undoc-members:
:show-inheritance:
pype.hosts.nukestudio.workio module
-----------------------------------
.. automodule:: pype.hosts.nukestudio.workio
:members:
:undoc-members:
:show-inheritance:

7
docs/source/pype.hosts.photoshop.rst Normal file
View file

@ -0,0 +1,7 @@
pype.hosts.photoshop package
============================
.. automodule:: pype.hosts.photoshop
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.hosts.premiere.rst Normal file
View file

@ -0,0 +1,18 @@
pype.hosts.premiere package
===========================
.. automodule:: pype.hosts.premiere
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.premiere.lib module
------------------------------
.. automodule:: pype.hosts.premiere.lib
:members:
:undoc-members:
:show-inheritance:

74
docs/source/pype.hosts.resolve.rst Normal file
View file

@ -0,0 +1,74 @@
pype.hosts.resolve package
==========================
.. automodule:: pype.hosts.resolve
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.resolve.action module
--------------------------------
.. automodule:: pype.hosts.resolve.action
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.lib module
-----------------------------
.. automodule:: pype.hosts.resolve.lib
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.menu module
------------------------------
.. automodule:: pype.hosts.resolve.menu
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.pipeline module
----------------------------------
.. automodule:: pype.hosts.resolve.pipeline
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.plugin module
--------------------------------
.. automodule:: pype.hosts.resolve.plugin
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.preload\_console module
------------------------------------------
.. automodule:: pype.hosts.resolve.preload_console
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.utils module
-------------------------------
.. automodule:: pype.hosts.resolve.utils
:members:
:undoc-members:
:show-inheritance:
pype.hosts.resolve.workio module
--------------------------------
.. automodule:: pype.hosts.resolve.workio
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.hosts.rst Normal file
View file

@ -0,0 +1,26 @@
pype.hosts package
==================
.. automodule:: pype.hosts
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.hosts.blender
pype.hosts.celaction
pype.hosts.fusion
pype.hosts.harmony
pype.hosts.houdini
pype.hosts.maya
pype.hosts.nuke
pype.hosts.nukestudio
pype.hosts.photoshop
pype.hosts.premiere
pype.hosts.resolve
pype.hosts.unreal

26
docs/source/pype.hosts.unreal.rst Normal file
View file

@ -0,0 +1,26 @@
pype.hosts.unreal package
=========================
.. automodule:: pype.hosts.unreal
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.hosts.unreal.lib module
----------------------------
.. automodule:: pype.hosts.unreal.lib
:members:
:undoc-members:
:show-inheritance:
pype.hosts.unreal.plugin module
-------------------------------
.. automodule:: pype.hosts.unreal.plugin
:members:
:undoc-members:
:show-inheritance:

20
docs/source/pype.houdini.rst
View file

@ -1,20 +0,0 @@
pype.houdini package
====================
.. automodule:: pype.houdini
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.houdini.lib module
-----------------------
.. automodule:: pype.houdini.lib
:members:
:undoc-members:
:show-inheritance:

90
docs/source/pype.lib.rst Normal file
View file

@ -0,0 +1,90 @@
pype.lib package
================
.. automodule:: pype.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.lib.anatomy module
-----------------------
.. automodule:: pype.lib.anatomy
:members:
:undoc-members:
:show-inheritance:
pype.lib.config module
----------------------
.. automodule:: pype.lib.config
:members:
:undoc-members:
:show-inheritance:
pype.lib.execute module
-----------------------
.. automodule:: pype.lib.execute
:members:
:undoc-members:
:show-inheritance:
pype.lib.git\_progress module
-----------------------------
.. automodule:: pype.lib.git_progress
:members:
:undoc-members:
:show-inheritance:
pype.lib.lib module
-------------------
.. automodule:: pype.lib.lib
:members:
:undoc-members:
:show-inheritance:
pype.lib.log module
-------------------
.. automodule:: pype.lib.log
:members:
:undoc-members:
:show-inheritance:
pype.lib.mongo module
---------------------
.. automodule:: pype.lib.mongo
:members:
:undoc-members:
:show-inheritance:
pype.lib.profiling module
-------------------------
.. automodule:: pype.lib.profiling
:members:
:undoc-members:
:show-inheritance:
pype.lib.terminal module
------------------------
.. automodule:: pype.lib.terminal
:members:
:undoc-members:
:show-inheritance:
pype.lib.user\_settings module
------------------------------
.. automodule:: pype.lib.user_settings
:members:
:undoc-members:
:show-inheritance:

52
docs/source/pype.maya.rst
View file

@ -1,52 +0,0 @@
pype.maya package
=================
.. automodule:: pype.maya
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.maya.action module
-----------------------
.. automodule:: pype.maya.action
:members:
:undoc-members:
:show-inheritance:
pype.maya.customize module
--------------------------
.. automodule:: pype.maya.customize
:members:
:undoc-members:
:show-inheritance:
pype.maya.lib module
--------------------
.. automodule:: pype.maya.lib
:members:
:undoc-members:
:show-inheritance:
pype.maya.menu module
---------------------
.. automodule:: pype.maya.menu
:members:
:undoc-members:
:show-inheritance:
pype.maya.plugin module
-----------------------
.. automodule:: pype.maya.plugin
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.adobe_communicator.lib.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.adobe\_communicator.lib package
============================================
.. automodule:: pype.modules.adobe_communicator.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.adobe\_communicator.lib.publish module
---------------------------------------------------
.. automodule:: pype.modules.adobe_communicator.lib.publish
:members:
:undoc-members:
:show-inheritance:
pype.modules.adobe\_communicator.lib.rest\_api module
-----------------------------------------------------
.. automodule:: pype.modules.adobe_communicator.lib.rest_api
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.adobe_communicator.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.adobe\_communicator package
========================================
.. automodule:: pype.modules.adobe_communicator
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.modules.adobe_communicator.lib
Submodules
----------
pype.modules.adobe\_communicator.adobe\_comunicator module
----------------------------------------------------------
.. automodule:: pype.modules.adobe_communicator.adobe_comunicator
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.avalon_apps.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.avalon\_apps package
=================================
.. automodule:: pype.modules.avalon_apps
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.avalon\_apps.avalon\_app module
--------------------------------------------
.. automodule:: pype.modules.avalon_apps.avalon_app
:members:
:undoc-members:
:show-inheritance:
pype.modules.avalon\_apps.rest\_api module
------------------------------------------
.. automodule:: pype.modules.avalon_apps.rest_api
:members:
:undoc-members:
:show-inheritance:

42
docs/source/pype.modules.clockify.rst Normal file
View file

@ -0,0 +1,42 @@
pype.modules.clockify package
=============================
.. automodule:: pype.modules.clockify
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.clockify.clockify module
-------------------------------------
.. automodule:: pype.modules.clockify.clockify
:members:
:undoc-members:
:show-inheritance:
pype.modules.clockify.clockify\_api module
------------------------------------------
.. automodule:: pype.modules.clockify.clockify_api
:members:
:undoc-members:
:show-inheritance:
pype.modules.clockify.constants module
--------------------------------------
.. automodule:: pype.modules.clockify.constants
:members:
:undoc-members:
:show-inheritance:
pype.modules.clockify.widgets module
------------------------------------
.. automodule:: pype.modules.clockify.widgets
:members:
:undoc-members:
:show-inheritance:

90
docs/source/pype.modules.ftrack.ftrack_server.rst Normal file
View file

@ -0,0 +1,90 @@
pype.modules.ftrack.ftrack\_server package
==========================================
.. automodule:: pype.modules.ftrack.ftrack_server
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.ftrack.ftrack\_server.custom\_db\_connector module
---------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.custom_db_connector
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.event\_server\_cli module
------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.event_server_cli
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.ftrack\_server module
--------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.ftrack_server
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.lib module
---------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.lib
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.socket\_thread module
--------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.socket_thread
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.sub\_event\_processor module
---------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.sub_event_processor
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.sub\_event\_status module
------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.sub_event_status
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.sub\_event\_storer module
------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.sub_event_storer
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.sub\_legacy\_server module
-------------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.sub_legacy_server
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.ftrack\_server.sub\_user\_server module
-----------------------------------------------------------
.. automodule:: pype.modules.ftrack.ftrack_server.sub_user_server
:members:
:undoc-members:
:show-inheritance:

58
docs/source/pype.modules.ftrack.lib.rst Normal file
View file

@ -0,0 +1,58 @@
pype.modules.ftrack.lib package
===============================
.. automodule:: pype.modules.ftrack.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.ftrack.lib.avalon\_sync module
-------------------------------------------
.. automodule:: pype.modules.ftrack.lib.avalon_sync
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.lib.credentials module
------------------------------------------
.. automodule:: pype.modules.ftrack.lib.credentials
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.lib.ftrack\_action\_handler module
------------------------------------------------------
.. automodule:: pype.modules.ftrack.lib.ftrack_action_handler
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.lib.ftrack\_app\_handler module
---------------------------------------------------
.. automodule:: pype.modules.ftrack.lib.ftrack_app_handler
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.lib.ftrack\_base\_handler module
----------------------------------------------------
.. automodule:: pype.modules.ftrack.lib.ftrack_base_handler
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.lib.ftrack\_event\_handler module
-----------------------------------------------------
.. automodule:: pype.modules.ftrack.lib.ftrack_event_handler
:members:
:undoc-members:
:show-inheritance:

17
docs/source/pype.modules.ftrack.rst Normal file
View file

@ -0,0 +1,17 @@
pype.modules.ftrack package
===========================
.. automodule:: pype.modules.ftrack
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.modules.ftrack.ftrack_server
pype.modules.ftrack.lib
pype.modules.ftrack.tray

34
docs/source/pype.modules.ftrack.tray.rst Normal file
View file

@ -0,0 +1,34 @@
pype.modules.ftrack.tray package
================================
.. automodule:: pype.modules.ftrack.tray
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.ftrack.tray.ftrack\_module module
----------------------------------------------
.. automodule:: pype.modules.ftrack.tray.ftrack_module
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.tray.login\_dialog module
---------------------------------------------
.. automodule:: pype.modules.ftrack.tray.login_dialog
:members:
:undoc-members:
:show-inheritance:
pype.modules.ftrack.tray.login\_tools module
--------------------------------------------
.. automodule:: pype.modules.ftrack.tray.login_tools
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.modules.idle_manager.rst Normal file
View file

@ -0,0 +1,18 @@
pype.modules.idle\_manager package
==================================
.. automodule:: pype.modules.idle_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.idle\_manager.idle\_manager module
-----------------------------------------------
.. automodule:: pype.modules.idle_manager.idle_manager
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.muster.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.muster package
===========================
.. automodule:: pype.modules.muster
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.muster.muster module
---------------------------------
.. automodule:: pype.modules.muster.muster
:members:
:undoc-members:
:show-inheritance:
pype.modules.muster.widget\_login module
----------------------------------------
.. automodule:: pype.modules.muster.widget_login
:members:
:undoc-members:
:show-inheritance:

42
docs/source/pype.modules.rest_api.lib.rst Normal file
View file

@ -0,0 +1,42 @@
pype.modules.rest\_api.lib package
==================================
.. automodule:: pype.modules.rest_api.lib
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.rest\_api.lib.exceptions module
--------------------------------------------
.. automodule:: pype.modules.rest_api.lib.exceptions
:members:
:undoc-members:
:show-inheritance:
pype.modules.rest\_api.lib.factory module
-----------------------------------------
.. automodule:: pype.modules.rest_api.lib.factory
:members:
:undoc-members:
:show-inheritance:
pype.modules.rest\_api.lib.handler module
-----------------------------------------
.. automodule:: pype.modules.rest_api.lib.handler
:members:
:undoc-members:
:show-inheritance:
pype.modules.rest\_api.lib.lib module
-------------------------------------
.. automodule:: pype.modules.rest_api.lib.lib
:members:
:undoc-members:
:show-inheritance:

34
docs/source/pype.modules.rest_api.rst Normal file
View file

@ -0,0 +1,34 @@
pype.modules.rest\_api package
==============================
.. automodule:: pype.modules.rest_api
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.modules.rest_api.lib
Submodules
----------
pype.modules.rest\_api.base\_class module
-----------------------------------------
.. automodule:: pype.modules.rest_api.base_class
:members:
:undoc-members:
:show-inheritance:
pype.modules.rest\_api.rest\_api module
---------------------------------------
.. automodule:: pype.modules.rest_api.rest_api
:members:
:undoc-members:
:show-inheritance:

36
docs/source/pype.modules.rst Normal file
View file

@ -0,0 +1,36 @@
pype.modules package
====================
.. automodule:: pype.modules
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.modules.adobe_communicator
pype.modules.avalon_apps
pype.modules.clockify
pype.modules.ftrack
pype.modules.idle_manager
pype.modules.muster
pype.modules.rest_api
pype.modules.standalonepublish
pype.modules.timers_manager
pype.modules.user
pype.modules.websocket_server
Submodules
----------
pype.modules.base module
------------------------
.. automodule:: pype.modules.base
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.modules.standalonepublish.rst Normal file
View file

@ -0,0 +1,18 @@
pype.modules.standalonepublish package
======================================
.. automodule:: pype.modules.standalonepublish
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.standalonepublish.standalonepublish\_module module
---------------------------------------------------------------
.. automodule:: pype.modules.standalonepublish.standalonepublish_module
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.timers_manager.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.timers\_manager package
====================================
.. automodule:: pype.modules.timers_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.timers\_manager.timers\_manager module
---------------------------------------------------
.. automodule:: pype.modules.timers_manager.timers_manager
:members:
:undoc-members:
:show-inheritance:
pype.modules.timers\_manager.widget\_user\_idle module
------------------------------------------------------
.. automodule:: pype.modules.timers_manager.widget_user_idle
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.user.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.user package
=========================
.. automodule:: pype.modules.user
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.user.user\_module module
-------------------------------------
.. automodule:: pype.modules.user.user_module
:members:
:undoc-members:
:show-inheritance:
pype.modules.user.widget\_user module
-------------------------------------
.. automodule:: pype.modules.user.widget_user
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.websocket_server.hosts.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.websocket\_server.hosts package
============================================
.. automodule:: pype.modules.websocket_server.hosts
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.modules.websocket\_server.hosts.external\_app\_1 module
------------------------------------------------------------
.. automodule:: pype.modules.websocket_server.hosts.external_app_1
:members:
:undoc-members:
:show-inheritance:
pype.modules.websocket\_server.hosts.photoshop module
-----------------------------------------------------
.. automodule:: pype.modules.websocket_server.hosts.photoshop
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.modules.websocket_server.rst Normal file
View file

@ -0,0 +1,26 @@
pype.modules.websocket\_server package
======================================
.. automodule:: pype.modules.websocket_server
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.modules.websocket_server.hosts
Submodules
----------
pype.modules.websocket\_server.websocket\_server module
-------------------------------------------------------
.. automodule:: pype.modules.websocket_server.websocket_server
:members:
:undoc-members:
:show-inheritance:

44
docs/source/pype.nuke.rst
View file

@ -1,44 +0,0 @@
pype.nuke package
=================
.. automodule:: pype.nuke
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.nuke.actions module
------------------------
.. automodule:: pype.nuke.actions
:members:
:undoc-members:
:show-inheritance:
pype.nuke.lib module
--------------------
.. automodule:: pype.nuke.lib
:members:
:undoc-members:
:show-inheritance:
pype.nuke.menu module
---------------------
.. automodule:: pype.nuke.menu
:members:
:undoc-members:
:show-inheritance:
pype.nuke.templates module
--------------------------
.. automodule:: pype.nuke.templates
:members:
:undoc-members:
:show-inheritance:

20
docs/source/pype.premiere.rst
View file

@ -1,20 +0,0 @@
pype.premiere package
=====================
.. automodule:: pype.premiere
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.premiere.templates module
------------------------------
.. automodule:: pype.premiere.templates
:members:
:undoc-members:
:show-inheritance:

7
docs/source/pype.resources.rst Normal file
View file

@ -0,0 +1,7 @@
pype.resources package
======================
.. automodule:: pype.resources
:members:
:undoc-members:
:show-inheritance:

49
docs/source/pype.rst
View file

@ -10,20 +10,17 @@ Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.aport
pype.avalon_apps
pype.clockify
pype.ftrack
pype.fusion
pype.houdini
pype.maya
pype.nuke
pype.premiere
pype.hosts
pype.lib
pype.modules
pype.resources
pype.scripts
pype.services
pype.standalonepublish
pype.settings
pype.tests
pype.tools
pype.vendor
pype.widgets
Submodules
@ -45,6 +42,14 @@ pype.api module
:undoc-members:
:show-inheritance:
pype.cli module
---------------
.. automodule:: pype.cli
:members:
:undoc-members:
:show-inheritance:
pype.launcher\_actions module
-----------------------------
@ -53,10 +58,10 @@ pype.launcher\_actions module
:undoc-members:
:show-inheritance:
pype.lib module
---------------
pype.modules\_manager module
----------------------------
.. automodule:: pype.lib
.. automodule:: pype.modules_manager
:members:
:undoc-members:
:show-inheritance:
@ -69,6 +74,14 @@ pype.plugin module
:undoc-members:
:show-inheritance:
pype.pype\_commands module
--------------------------
.. automodule:: pype.pype_commands
:members:
:undoc-members:
:show-inheritance:
pype.setdress\_api module
-------------------------
@ -77,12 +90,10 @@ pype.setdress\_api module
:undoc-members:
:show-inheritance:
pype.templates module
---------------------
pype.version module
-------------------
.. automodule:: pype.templates
.. automodule:: pype.version
:members:
:undoc-members:
:show-inheritance:

34
docs/source/pype.scripts.rst
View file

@ -6,9 +6,25 @@ pype.scripts package
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.scripts.slates
Submodules
----------
pype.scripts.export\_maya\_ass\_job module
------------------------------------------
.. automodule:: pype.scripts.export_maya_ass_job
:members:
:undoc-members:
:show-inheritance:
pype.scripts.fusion\_switch\_shot module
----------------------------------------
@ -17,6 +33,22 @@ pype.scripts.fusion\_switch\_shot module
:undoc-members:
:show-inheritance:
pype.scripts.otio\_burnin module
--------------------------------
.. automodule:: pype.scripts.otio_burnin
:members:
:undoc-members:
:show-inheritance:
pype.scripts.publish\_deadline module
-------------------------------------
.. automodule:: pype.scripts.publish_deadline
:members:
:undoc-members:
:show-inheritance:
pype.scripts.publish\_filesequence module
-----------------------------------------
@ -24,5 +56,3 @@ pype.scripts.publish\_filesequence module
:members:
:undoc-members:
:show-inheritance:

15
docs/source/pype.scripts.slates.rst Normal file
View file

@ -0,0 +1,15 @@
pype.scripts.slates package
===========================
.. automodule:: pype.scripts.slates
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.scripts.slates.slate_base

74
docs/source/pype.scripts.slates.slate_base.rst Normal file
View file

@ -0,0 +1,74 @@
pype.scripts.slates.slate\_base package
=======================================
.. automodule:: pype.scripts.slates.slate_base
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.scripts.slates.slate\_base.api module
------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.api
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.base module
-------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.base
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.example module
----------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.example
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.font\_factory module
----------------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.font_factory
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.items module
--------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.items
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.layer module
--------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.layer
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.lib module
------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.lib
:members:
:undoc-members:
:show-inheritance:
pype.scripts.slates.slate\_base.main\_frame module
--------------------------------------------------
.. automodule:: pype.scripts.slates.slate_base.main_frame
:members:
:undoc-members:
:show-inheritance:

20
docs/source/pype.services.idle_manager.rst
View file

@ -1,20 +0,0 @@
pype.services.idle\_manager package
===================================
.. automodule:: pype.services.idle_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.idle\_manager.idle\_manager module
------------------------------------------------
.. automodule:: pype.services.idle_manager.idle_manager
:members:
:undoc-members:
:show-inheritance:

17
docs/source/pype.services.rst
View file

@ -1,17 +0,0 @@
pype.services package
=====================
.. automodule:: pype.services
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.services.idle_manager
pype.services.statics_server
pype.services.timers_manager

20
docs/source/pype.services.statics_server.rst
View file

@ -1,20 +0,0 @@
pype.services.statics\_server package
=====================================
.. automodule:: pype.services.statics_server
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.statics\_server.statics\_server module
----------------------------------------------------
.. automodule:: pype.services.statics_server.statics_server
:members:
:undoc-members:
:show-inheritance:

28
docs/source/pype.services.timers_manager.rst
View file

@ -1,28 +0,0 @@
pype.services.timers\_manager package
=====================================
.. automodule:: pype.services.timers_manager
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.services.timers\_manager.timers\_manager module
----------------------------------------------------
.. automodule:: pype.services.timers_manager.timers_manager
:members:
:undoc-members:
:show-inheritance:
pype.services.timers\_manager.widget\_user\_idle module
-------------------------------------------------------
.. automodule:: pype.services.timers_manager.widget_user_idle
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.settings.rst Normal file
View file

@ -0,0 +1,18 @@
pype.settings package
=====================
.. automodule:: pype.settings
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.settings.lib module
------------------------
.. automodule:: pype.settings.lib
:members:
:undoc-members:
:show-inheritance:

8
docs/source/pype.standalonepublish.resources.rst
View file

@ -1,8 +0,0 @@
pype.standalonepublish.resources package
========================================
.. automodule:: pype.standalonepublish.resources
:members:
:undoc-members:
:show-inheritance:

44
docs/source/pype.standalonepublish.rst
View file

@ -1,44 +0,0 @@
pype.standalonepublish package
==============================
.. automodule:: pype.standalonepublish
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
pype.standalonepublish.resources
pype.standalonepublish.widgets
Submodules
----------
pype.standalonepublish.app module
---------------------------------
.. automodule:: pype.standalonepublish.app
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.publish module
-------------------------------------
.. automodule:: pype.standalonepublish.publish
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.standalonepublish\_module module
-------------------------------------------------------
.. automodule:: pype.standalonepublish.standalonepublish_module
:members:
:undoc-members:
:show-inheritance:

156
docs/source/pype.standalonepublish.widgets.rst
View file

@ -1,156 +0,0 @@
pype.standalonepublish.widgets package
======================================
.. automodule:: pype.standalonepublish.widgets
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.standalonepublish.widgets.button\_from\_svgs module
--------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.button_from_svgs
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_asset module
--------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_asset
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_filter\_proxy\_exact\_match module
------------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_filter_proxy_exact_match
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_filter\_proxy\_recursive\_sort module
---------------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_filter_proxy_recursive_sort
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_node module
-------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_node
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tasks\_template module
------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tasks_template
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tree module
-------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tree
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.model\_tree\_view\_deselectable module
---------------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.model_tree_view_deselectable
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_asset module
---------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_asset
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_asset\_view module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_asset_view
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_component\_item module
-------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_component_item
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_components module
--------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_components
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_components\_list module
--------------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_components_list
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_drop\_empty module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_drop_empty
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_drop\_frame module
---------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_drop_frame
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_family module
----------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_family
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_family\_desc module
----------------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_family_desc
:members:
:undoc-members:
:show-inheritance:
pype.standalonepublish.widgets.widget\_shadow module
----------------------------------------------------
.. automodule:: pype.standalonepublish.widgets.widget_shadow
:members:
:undoc-members:
:show-inheritance:

42
docs/source/pype.tests.rst Normal file
View file

@ -0,0 +1,42 @@
pype.tests package
==================
.. automodule:: pype.tests
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.tests.lib module
---------------------
.. automodule:: pype.tests.lib
:members:
:undoc-members:
:show-inheritance:
pype.tests.test\_avalon\_plugin\_presets module
-----------------------------------------------
.. automodule:: pype.tests.test_avalon_plugin_presets
:members:
:undoc-members:
:show-inheritance:
pype.tests.test\_mongo\_performance module
------------------------------------------
.. automodule:: pype.tests.test_mongo_performance
:members:
:undoc-members:
:show-inheritance:
pype.tests.test\_pyblish\_filter module
---------------------------------------
.. automodule:: pype.tests.test_pyblish_filter
:members:
:undoc-members:
:show-inheritance:

2
docs/source/pype.tools.assetcreator.rst
View file

@ -32,5 +32,3 @@ pype.tools.assetcreator.widget module
:members:
:undoc-members:
:show-inheritance:

66
docs/source/pype.tools.launcher.rst Normal file
View file

@ -0,0 +1,66 @@
pype.tools.launcher package
===========================
.. automodule:: pype.tools.launcher
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.tools.launcher.actions module
----------------------------------
.. automodule:: pype.tools.launcher.actions
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.delegates module
------------------------------------
.. automodule:: pype.tools.launcher.delegates
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.flickcharm module
-------------------------------------
.. automodule:: pype.tools.launcher.flickcharm
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.lib module
------------------------------
.. automodule:: pype.tools.launcher.lib
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.models module
---------------------------------
.. automodule:: pype.tools.launcher.models
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.widgets module
----------------------------------
.. automodule:: pype.tools.launcher.widgets
:members:
:undoc-members:
:show-inheritance:
pype.tools.launcher.window module
---------------------------------
.. automodule:: pype.tools.launcher.window
:members:
:undoc-members:
:show-inheritance:

130
docs/source/pype.tools.pyblish_pype.rst Normal file
View file

@ -0,0 +1,130 @@
pype.tools.pyblish\_pype package
================================
.. automodule:: pype.tools.pyblish_pype
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.pyblish_pype.vendor
Submodules
----------
pype.tools.pyblish\_pype.app module
-----------------------------------
.. automodule:: pype.tools.pyblish_pype.app
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.awesome module
---------------------------------------
.. automodule:: pype.tools.pyblish_pype.awesome
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.compat module
--------------------------------------
.. automodule:: pype.tools.pyblish_pype.compat
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.constants module
-----------------------------------------
.. automodule:: pype.tools.pyblish_pype.constants
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.control module
---------------------------------------
.. automodule:: pype.tools.pyblish_pype.control
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.delegate module
----------------------------------------
.. automodule:: pype.tools.pyblish_pype.delegate
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.mock module
------------------------------------
.. automodule:: pype.tools.pyblish_pype.mock
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.model module
-------------------------------------
.. automodule:: pype.tools.pyblish_pype.model
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.settings module
----------------------------------------
.. automodule:: pype.tools.pyblish_pype.settings
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.util module
------------------------------------
.. automodule:: pype.tools.pyblish_pype.util
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.version module
---------------------------------------
.. automodule:: pype.tools.pyblish_pype.version
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.view module
------------------------------------
.. automodule:: pype.tools.pyblish_pype.view
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.widgets module
---------------------------------------
.. automodule:: pype.tools.pyblish_pype.widgets
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.window module
--------------------------------------
.. automodule:: pype.tools.pyblish_pype.window
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.tools.pyblish_pype.vendor.qtawesome.rst Normal file
View file

@ -0,0 +1,26 @@
pype.tools.pyblish\_pype.vendor.qtawesome package
=================================================
.. automodule:: pype.tools.pyblish_pype.vendor.qtawesome
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.tools.pyblish\_pype.vendor.qtawesome.animation module
----------------------------------------------------------
.. automodule:: pype.tools.pyblish_pype.vendor.qtawesome.animation
:members:
:undoc-members:
:show-inheritance:
pype.tools.pyblish\_pype.vendor.qtawesome.iconic\_font module
-------------------------------------------------------------
.. automodule:: pype.tools.pyblish_pype.vendor.qtawesome.iconic_font
:members:
:undoc-members:
:show-inheritance:

15
docs/source/pype.tools.pyblish_pype.vendor.rst Normal file
View file

@ -0,0 +1,15 @@
pype.tools.pyblish\_pype.vendor package
=======================================
.. automodule:: pype.tools.pyblish_pype.vendor
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.pyblish_pype.vendor.qtawesome

6
docs/source/pype.tools.rst
View file

@ -10,6 +10,10 @@ Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.assetcreator
pype.tools.launcher
pype.tools.pyblish_pype
pype.tools.settings
pype.tools.standalonepublish

15
docs/source/pype.tools.settings.rst Normal file
View file

@ -0,0 +1,15 @@
pype.tools.settings package
===========================
.. automodule:: pype.tools.settings
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.settings.settings

16
docs/source/pype.tools.settings.settings.rst Normal file
View file

@ -0,0 +1,16 @@
pype.tools.settings.settings package
====================================
.. automodule:: pype.tools.settings.settings
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.settings.settings.style
pype.tools.settings.settings.widgets

7
docs/source/pype.tools.settings.settings.style.rst Normal file
View file

@ -0,0 +1,7 @@
pype.tools.settings.settings.style package
==========================================
.. automodule:: pype.tools.settings.settings.style
:members:
:undoc-members:
:show-inheritance:

74
docs/source/pype.tools.settings.settings.widgets.rst Normal file
View file

@ -0,0 +1,74 @@
pype.tools.settings.settings.widgets package
============================================
.. automodule:: pype.tools.settings.settings.widgets
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.tools.settings.settings.widgets.anatomy\_types module
----------------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.anatomy_types
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.base module
------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.base
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.item\_types module
-------------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.item_types
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.lib module
-----------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.lib
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.multiselection\_combobox module
--------------------------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.multiselection_combobox
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.tests module
-------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.tests
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.widgets module
---------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.widgets
:members:
:undoc-members:
:show-inheritance:
pype.tools.settings.settings.widgets.window module
--------------------------------------------------
.. automodule:: pype.tools.settings.settings.widgets.window
:members:
:undoc-members:
:show-inheritance:

34
docs/source/pype.tools.standalonepublish.rst Normal file
View file

@ -0,0 +1,34 @@
pype.tools.standalonepublish package
====================================
.. automodule:: pype.tools.standalonepublish
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.standalonepublish.widgets
Submodules
----------
pype.tools.standalonepublish.app module
---------------------------------------
.. automodule:: pype.tools.standalonepublish.app
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.publish module
-------------------------------------------
.. automodule:: pype.tools.standalonepublish.publish
:members:
:undoc-members:
:show-inheritance:

7
docs/source/pype.tools.standalonepublish.widgets.resources.rst Normal file
View file

@ -0,0 +1,7 @@
pype.tools.standalonepublish.widgets.resources package
======================================================
.. automodule:: pype.tools.standalonepublish.widgets.resources
:members:
:undoc-members:
:show-inheritance:

146
docs/source/pype.tools.standalonepublish.widgets.rst Normal file
View file

@ -0,0 +1,146 @@
pype.tools.standalonepublish.widgets package
============================================
.. automodule:: pype.tools.standalonepublish.widgets
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.tools.standalonepublish.widgets.resources
Submodules
----------
pype.tools.standalonepublish.widgets.model\_asset module
--------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_asset
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_filter\_proxy\_exact\_match module
------------------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_filter_proxy_exact_match
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_filter\_proxy\_recursive\_sort module
---------------------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_filter_proxy_recursive_sort
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_node module
-------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_node
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_tasks\_template module
------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_tasks_template
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_tree module
-------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_tree
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.model\_tree\_view\_deselectable module
---------------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.model_tree_view_deselectable
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_asset module
---------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_asset
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_component\_item module
-------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_component_item
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_components module
--------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_components
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_components\_list module
--------------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_components_list
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_drop\_empty module
---------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_drop_empty
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_drop\_frame module
---------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_drop_frame
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_family module
----------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_family
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_family\_desc module
----------------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_family_desc
:members:
:undoc-members:
:show-inheritance:
pype.tools.standalonepublish.widgets.widget\_shadow module
----------------------------------------------------------
.. automodule:: pype.tools.standalonepublish.widgets.widget_shadow
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.vendor.backports.configparser.rst Normal file
View file

@ -0,0 +1,18 @@
pype.vendor.backports.configparser package
==========================================
.. automodule:: pype.vendor.backports.configparser
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.backports.configparser.helpers module
-------------------------------------------------
.. automodule:: pype.vendor.backports.configparser.helpers
:members:
:undoc-members:
:show-inheritance:

26
docs/source/pype.vendor.backports.rst Normal file
View file

@ -0,0 +1,26 @@
pype.vendor.backports package
=============================
.. automodule:: pype.vendor.backports
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.vendor.backports.configparser
Submodules
----------
pype.vendor.backports.functools\_lru\_cache module
--------------------------------------------------
.. automodule:: pype.vendor.backports.functools_lru_cache
:members:
:undoc-members:
:show-inheritance:

7
docs/source/pype.vendor.builtins.rst Normal file
View file

@ -0,0 +1,7 @@
pype.vendor.builtins package
============================
.. automodule:: pype.vendor.builtins
:members:
:undoc-members:
:show-inheritance:

82
docs/source/pype.vendor.capture_gui.rst Normal file
View file

@ -0,0 +1,82 @@
pype.vendor.capture\_gui package
================================
.. automodule:: pype.vendor.capture_gui
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.vendor.capture_gui.vendor
Submodules
----------
pype.vendor.capture\_gui.accordion module
-----------------------------------------
.. automodule:: pype.vendor.capture_gui.accordion
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.app module
-----------------------------------
.. automodule:: pype.vendor.capture_gui.app
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.colorpicker module
-------------------------------------------
.. automodule:: pype.vendor.capture_gui.colorpicker
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.lib module
-----------------------------------
.. automodule:: pype.vendor.capture_gui.lib
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.plugin module
--------------------------------------
.. automodule:: pype.vendor.capture_gui.plugin
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.presets module
---------------------------------------
.. automodule:: pype.vendor.capture_gui.presets
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.tokens module
--------------------------------------
.. automodule:: pype.vendor.capture_gui.tokens
:members:
:undoc-members:
:show-inheritance:
pype.vendor.capture\_gui.version module
---------------------------------------
.. automodule:: pype.vendor.capture_gui.version
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.vendor.capture_gui.vendor.rst Normal file
View file

@ -0,0 +1,18 @@
pype.vendor.capture\_gui.vendor package
=======================================
.. automodule:: pype.vendor.capture_gui.vendor
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.capture\_gui.vendor.Qt module
-----------------------------------------
.. automodule:: pype.vendor.capture_gui.vendor.Qt
:members:
:undoc-members:
:show-inheritance:

34
docs/source/pype.vendor.ftrack_api_old.accessor.rst Normal file
View file

@ -0,0 +1,34 @@
pype.vendor.ftrack\_api\_old.accessor package
=============================================
.. automodule:: pype.vendor.ftrack_api_old.accessor
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.ftrack\_api\_old.accessor.base module
-------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.accessor.base
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.accessor.disk module
-------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.accessor.disk
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.accessor.server module
---------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.accessor.server
:members:
:undoc-members:
:show-inheritance:

82
docs/source/pype.vendor.ftrack_api_old.entity.rst Normal file
View file

@ -0,0 +1,82 @@
pype.vendor.ftrack\_api\_old.entity package
===========================================
.. automodule:: pype.vendor.ftrack_api_old.entity
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.ftrack\_api\_old.entity.asset\_version module
---------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.asset_version
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.base module
-----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.base
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.component module
----------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.component
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.factory module
--------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.factory
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.job module
----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.job
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.location module
---------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.location
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.note module
-----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.note
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.project\_schema module
----------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.project_schema
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.entity.user module
-----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.entity.user
:members:
:undoc-members:
:show-inheritance:

50
docs/source/pype.vendor.ftrack_api_old.event.rst Normal file
View file

@ -0,0 +1,50 @@
pype.vendor.ftrack\_api\_old.event package
==========================================
.. automodule:: pype.vendor.ftrack_api_old.event
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.ftrack\_api\_old.event.base module
----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.event.base
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.event.expression module
----------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.event.expression
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.event.hub module
---------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.event.hub
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.event.subscriber module
----------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.event.subscriber
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.event.subscription module
------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.event.subscription
:members:
:undoc-members:
:show-inheritance:

18
docs/source/pype.vendor.ftrack_api_old.resource_identifier_transformer.rst Normal file
View file

@ -0,0 +1,18 @@
pype.vendor.ftrack\_api\_old.resource\_identifier\_transformer package
======================================================================
.. automodule:: pype.vendor.ftrack_api_old.resource_identifier_transformer
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.ftrack\_api\_old.resource\_identifier\_transformer.base module
--------------------------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.resource_identifier_transformer.base
:members:
:undoc-members:
:show-inheritance:

126
docs/source/pype.vendor.ftrack_api_old.rst Normal file
View file

@ -0,0 +1,126 @@
pype.vendor.ftrack\_api\_old package
====================================
.. automodule:: pype.vendor.ftrack_api_old
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.vendor.ftrack_api_old.accessor
pype.vendor.ftrack_api_old.entity
pype.vendor.ftrack_api_old.event
pype.vendor.ftrack_api_old.resource_identifier_transformer
pype.vendor.ftrack_api_old.structure
Submodules
----------
pype.vendor.ftrack\_api\_old.attribute module
---------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.attribute
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.cache module
-----------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.cache
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.collection module
----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.collection
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.data module
----------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.data
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.exception module
---------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.exception
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.formatter module
---------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.formatter
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.inspection module
----------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.inspection
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.logging module
-------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.logging
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.operation module
---------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.operation
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.plugin module
------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.plugin
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.query module
-----------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.query
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.session module
-------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.session
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.symbol module
------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.symbol
:members:
:undoc-members:
:show-inheritance:

50
docs/source/pype.vendor.ftrack_api_old.structure.rst Normal file
View file

@ -0,0 +1,50 @@
pype.vendor.ftrack\_api\_old.structure package
==============================================
.. automodule:: pype.vendor.ftrack_api_old.structure
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
pype.vendor.ftrack\_api\_old.structure.base module
--------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.structure.base
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.structure.entity\_id module
--------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.structure.entity_id
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.structure.id module
------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.structure.id
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.structure.origin module
----------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.structure.origin
:members:
:undoc-members:
:show-inheritance:
pype.vendor.ftrack\_api\_old.structure.standard module
------------------------------------------------------
.. automodule:: pype.vendor.ftrack_api_old.structure.standard
:members:
:undoc-members:
:show-inheritance:

37
docs/source/pype.vendor.rst Normal file
View file

@ -0,0 +1,37 @@
pype.vendor package
===================
.. automodule:: pype.vendor
:members:
:undoc-members:
:show-inheritance:
Subpackages
-----------
.. toctree::
:maxdepth: 6
pype.vendor.backports
pype.vendor.builtins
pype.vendor.capture_gui
pype.vendor.ftrack_api_old
Submodules
----------
pype.vendor.capture module
--------------------------
.. automodule:: pype.vendor.capture
:members:
:undoc-members:
:show-inheritance:
pype.vendor.pysync module
-------------------------
.. automodule:: pype.vendor.pysync
:members:
:undoc-members:
:show-inheritance:

2
docs/source/pype.widgets.rst
View file

@ -32,5 +32,3 @@ pype.widgets.project\_settings module
:members:
:undoc-members:
:show-inheritance:

1
docs/source/readme.rst
View file

@ -1 +1,2 @@
.. title:: Pype Readme
.. include:: ../../README.md

8
igniter/__init__.py
View file

@ -5,6 +5,7 @@ import sys
from Qt import QtWidgets
from .install_dialog import InstallDialog
from .bootstrap_repos import BootstrapRepos
def run():
@ -12,3 +13,10 @@ def run():
d = InstallDialog()
d.show()
sys.exit(app.exec_())
__all__ = [
"InstallDialog",
"BootstrapRepos",
"run"
]

143
igniter/bootstrap_repos.py
View file

@ -8,52 +8,51 @@ import shutil
import tempfile
from typing import Union, Callable, Dict
from zipfile import ZipFile
from pathlib import Path
from appdirs import user_data_dir
from pype.version import __version__
from pype.lib import PypeSettingsRegistry
from igniter.tools import load_environments
class BootstrapRepos:
"""Class for bootstrapping local Pype installation.
Attributes:
data_dir (str): local Pype installation directory.
live_repo_dir (str): path to repos directory if running live,
data_dir (Path): local Pype installation directory.
live_repo_dir (Path): path to repos directory if running live,
otherwise `None`.
"""
_vendor = "pypeclub"
_app = "pype"
def __init__(self):
# vendor and app used to construct user data dir
self._vendor = "pypeclub"
self._app = "pype"
self._log = log.getLogger(str(__class__))
self.data_dir = user_data_dir(self._app, self._vendor)
if getattr(sys, 'frozen', False):
self.live_repo_dir = os.path.join(
os.path.dirname(sys.executable),
"repos"
)
self.data_dir = Path(user_data_dir(self._app, self._vendor))
self.registry = PypeSettingsRegistry()
if getattr(sys, "frozen", False):
self.live_repo_dir = Path(sys.executable).parent / "repos"
else:
self.live_repo_dir = os.path.abspath(
os.path.join(
os.path.dirname(__file__),
"..",
"repos"
)
)
self.live_repo_dir = Path(Path(__file__).parent / ".." / "repos")
@staticmethod
def get_local_version() -> str:
"""Get version of local Pype."""
return __version__
def install_live_repos(self, progress_callback=None) -> Union[str, None]:
def install_live_repos(self, progress_callback=None) -> Union[Path, None]:
"""Copy zip created from local repositories to user data dir.
Args:
progress_callback (callable): Optional callback method to report
progress.
Returns:
str: path of installed repository file.
Path: path of installed repository file.
"""
# dummy progress reporter
def empty_progress(x: int):
@ -64,7 +63,6 @@ class BootstrapRepos:
# create zip from repositories
local_version = self.get_local_version()
repo_dir = self.live_repo_dir
# create destination directory
try:
@ -72,45 +70,42 @@ class BootstrapRepos:
except OSError:
self._log.error("directory already exists")
with tempfile.TemporaryDirectory() as temp_dir:
temp_zip = os.path.join(
temp_dir,
f"pype-repositories-v{local_version}.zip"
)
temp_zip = \
Path(temp_dir) / f"pype-repositories-v{local_version}.zip"
self._log.info(f"creating zip: {temp_zip}")
BootstrapRepos._create_pype_zip(
temp_zip, repo_dir, progress_callback=progress_callback)
temp_zip, self.live_repo_dir, progress_callback=progress_callback)
if not os.path.exists(temp_zip):
self._log.error("make archive failed.")
return None
destination = os.path.join(
self.data_dir, os.path.basename(temp_zip))
destination = self.data_dir / temp_zip.name
if os.path.exists(destination):
if destination.exists():
self._log.warning(
f"Destination file {destination} exists, removing.")
try:
os.remove(destination)
destination.unlink()
except Exception as e:
self._log.error(e)
return None
try:
shutil.move(temp_zip, self.data_dir)
shutil.move(temp_zip.as_posix(), self.data_dir.as_posix())
except shutil.Error as e:
self._log.error(e)
return None
return os.path.join(self.data_dir, os.path.basename(temp_zip))
return self.data_dir / temp_zip.name
@staticmethod
def _create_pype_zip(
zip_path: str, include_dir: str,
zip_path: Path, include_dir: Path,
progress_callback: Callable, include_pype: bool = True) -> None:
"""Pack repositories and Pype into zip.
We are using `zipfile` instead :meth:`shutil.make_archive` to later
implement file filter to skip git related stuff to make it into
archive.
We are using :mod:`zipfile` instead :meth:`shutil.make_archive`
to later implement file filter to skip git related stuff to make
it into archive.
Todo:
Implement file filter
@ -118,9 +113,11 @@ class BootstrapRepos:
Args:
zip_path (str): path to zip file.
include_dir: repo directories to include.
progress_callback (Callable): callback to report progress back to
UI progress bar.
progress_callback (Callable(progress: int): callback to
report progress back to UI progress bar. It takes progress
percents as argument.
include_pype (bool): add Pype module itself.
"""
repo_files = sum(len(files) for _, _, files in os.walk(include_dir))
assert repo_files != 0, f"No repositories to include in {include_dir}"
@ -161,8 +158,8 @@ class BootstrapRepos:
progress_callback(100)
@staticmethod
def add_paths_from_archive(archive: str) -> None:
"""Add first-level directories as paths to sys.path.
def add_paths_from_archive(archive: Path) -> None:
"""Add first-level directories as paths to :mod:`sys.path`.
This will enable Python to import modules is second-level directories
in zip file.
@ -188,26 +185,74 @@ class BootstrapRepos:
os.environ["PYTHONPATH"] = os.pathsep.join(paths)
def find_pype(self) -> Union[Dict, None]:
def find_pype(self) -> Union[Dict[str, Path], None]:
"""Get ordered dict of detected Pype version.
Resolution order for Pype is following:
1) First we test for ``PYPE_PATH`` environment variable
2) We try to find ``pypePath`` in registry setting
3) We use user data directory
Returns:
dict: Dictionary of detected Pype version. Key is version, value
is path to zip file.
dict of Path: Dictionary of detected Pype version.
Key is version, value is path to zip file.
None: if Pype is not found.
"""
dir_to_search = self.data_dir
if os.getenv("PYPE_PATH"):
if Path(os.getenv("PYPE_PATH")).exists():
dir_to_search = Path(os.getenv("PYPE_PATH"))
else:
try:
registry_dir = Path(self.registry.get_item("pypePath"))
if registry_dir.exists():
dir_to_search = registry_dir
except ValueError:
# nothing found in registry, we'll use data dir
pass
# pype installation dir doesn't exists
if not os.path.exists(self.data_dir):
if not dir_to_search.exists():
return None
# f"pype-repositories-v{local_version}.zip"
files = os.listdir(self.data_dir)
_pype_versions = {}
for file in files:
for file in dir_to_search.iterdir():
m = re.match(
r"^pype-repositories-v(?P<version>\d+\.\d+\.\d+).zip$", file)
r"^pype-repositories-v(?P<version>\d+\.\d+\.\d+).zip$",
file.name)
if m:
_pype_versions[m.group("version")] = os.path.join(
self.data_dir, file)
_pype_versions[m.group("version")] = file
return dict(sorted(_pype_versions.items()))
@staticmethod
def _get_pype_from_mongo(mongo_url: str) -> Union[Path, None]:
"""Get path from Mongo database.
This sets environment variable ``AVALON_MONGO`` for
:mod:`pype.settings` to be able to read data from database.
It will then retrieve environment variables and among them
must be ``PYPE_ROOT``.
Args:
mongo_url (str): mongodb connection url
Returns:
Path: if path from ``PYPE_ROOT`` is found.
None: if not.
"""
os.environ["AVALON_MONGO"] = mongo_url
env = load_environments()
if not env.get("PYPE_ROOT"):
return None
return Path(env.get("PYPE_ROOT"))
def process_entered_path(self, location: str) -> str:
pype_path = None
if location.startswith("mongodb"):
self._get_pype_from_mongo(location)

173
igniter/install_dialog.py
View file

@ -2,8 +2,10 @@
"""Show dialog for choosing central pype repository."""
import sys
import os
import re
from Qt import QtCore, QtGui, QtWidgets
from Qt.QtGui import QValidator
from .install_thread import InstallThread
from .tools import validate_path_string
@ -53,7 +55,12 @@ class InstallDialog(QtWidgets.QDialog):
self._init_ui()
def _init_ui(self):
self.setStyleSheet("background-color: rgb(23, 23, 23);")
# basic visual style - dark background, light text
self.setStyleSheet("""
color: rgb(200, 200, 200);
background-color: rgb(23, 23, 23);
""")
main = QtWidgets.QVBoxLayout(self)
# Main info
@ -101,6 +108,8 @@ class InstallDialog(QtWidgets.QDialog):
"border: 1px solid rgb(32, 32, 32);")
)
self.user_input.setValidator(PathValidator(self.user_input))
self._btn_select = QtWidgets.QPushButton("Select")
self._btn_select.setToolTip(
"Select Pype repository"
@ -157,7 +166,7 @@ class InstallDialog(QtWidgets.QDialog):
bottom_widget.setLayout(bottom_layout)
bottom_widget.setStyleSheet("background-color: rgb(32, 32, 32);")
# Status label
# Console label
# --------------------------------------------------------------------
self._status_label = QtWidgets.QLabel("Console:")
self._status_label.setContentsMargins(0, 10, 0, 10)
@ -237,8 +246,16 @@ class InstallDialog(QtWidgets.QDialog):
self.setLayout(main)
def _on_select_clicked(self):
filename = QtWidgets.QFileDialog.getExistingDirectory(
self, 'Select path')
"""Show directory dialog."""
options = QtWidgets.QFileDialog.Options()
options |= QtWidgets.QFileDialog.DontUseNativeDialog
options |= QtWidgets.QFileDialog.ShowDirsOnly
filename, _ = QtWidgets.QFileDialog.getOpenFileName(
parent=self,
caption='Select path',
directory=os.getcwd(),
options=options)
if filename:
filename = QtCore.QDir.toNativeSeparators(filename)
@ -247,6 +264,33 @@ class InstallDialog(QtWidgets.QDialog):
self.user_input.setText(filename)
def _on_ok_clicked(self):
"""Start install process.
This will once again validate entered path and if ok, start
working thread that will do actual job.
"""
valid, reason = validate_path_string(self._path)
if not valid:
self.user_input.setStyleSheet(
"""
background-color: rgb(32, 19, 19);
color: rgb(255, 69, 0);
padding: 0.5em;
border: 1px solid rgb(32, 64, 32);
"""
)
self._update_console(reason, True)
return
else:
self.user_input.setStyleSheet(
"""
background-color: rgb(19, 19, 19);
color: rgb(64, 230, 132);
padding: 0.5em;
border: 1px solid rgb(32, 64, 32);
"""
)
self._disable_buttons()
self._install_thread = InstallThread(self)
self._install_thread.message.connect(self._update_console)
@ -261,41 +305,13 @@ class InstallDialog(QtWidgets.QDialog):
def _on_exit_clicked(self):
self.close()
def _path_changed(self, path: str) -> None:
"""Validate entered path.
It can be regular path - in that case we test if it does exist.
It can also be mongodb connection string. In that case we parse it
as url (it should start with `mongodb:`url schema.
Args:
path (str): path, connection string url or pype token.
Todo:
It can also be Pype token, binding it to Pype user account.
"""
valid, reason = validate_path_string(path)
if not valid:
self.user_input.setStyleSheet(
"""
background-color: rgb(32, 19, 19);
color: rgb(255, 69, 0);
"""
)
self._update_console(reason, True)
else:
self.user_input.setStyleSheet(
"""
background-color: rgb(31, 43, 32)
color: rgb(91, 159, 49)
"""
)
self._update_console(reason)
def _path_changed(self, path: str) -> str:
"""Set path."""
self._path = path
return path
def _update_console(self, msg: str, error: bool = False) -> None:
"""Display message.
"""Display message in console.
Args:
msg (str): message.
@ -308,23 +324,108 @@ class InstallDialog(QtWidgets.QDialog):
self._status_box.appendPlainText(msg)
def _disable_buttons(self):
"""Disable buttons so user interaction doesn't interfere."""
self._btn_select.setEnabled(False)
self._exit_button.setEnabled(False)
self._ok_button.setEnabled(False)
self._controls_disabled = True
def _enable_buttons(self):
"""Enable buttons after operation is complete."""
self._btn_select.setEnabled(True)
self._exit_button.setEnabled(True)
self._ok_button.setEnabled(True)
self._controls_disabled = False
def closeEvent(self, event):
"""Prevent closing if window when controls are disabled."""
if self._controls_disabled:
return event.ignore()
return super(InstallDialog, self).closeEvent(event)
class PathValidator(QValidator):
def __init__(self, parent=None):
self.parent = parent
super(PathValidator, self).__init__(parent)
def _return_state(
self, state: QValidator.State, reason: str, path: str, pos: int):
"""Set stylesheets and actions on parent based on state.
Warning:
This will always return `QFileDialog.State.Acceptable` as
anything different will stop input to `QLineEdit`
"""
if state == QValidator.State.Invalid:
self.parent.setToolTip(reason)
self.parent.setStyleSheet(
"""
background-color: rgb(32, 19, 19);
color: rgb(255, 69, 0);
padding: 0.5em;
border: 1px solid rgb(32, 64, 32);
"""
)
elif state == QValidator.State.Intermediate:
self.parent.setToolTip(reason)
self.parent.setStyleSheet(
"""
background-color: rgb(32, 32, 19);
color: rgb(255, 190, 15);
padding: 0.5em;
border: 1px solid rgb(64, 64, 32);
"""
)
else:
self.parent.setToolTip(reason)
self.parent.setStyleSheet(
"""
background-color: rgb(19, 19, 19);
color: rgb(64, 230, 132);
padding: 0.5em;
border: 1px solid rgb(32, 64, 32);
"""
)
return QValidator.State.Acceptable, path, len(path)
def validate(self, path: str, pos: int) -> (QValidator.State, str, int):
"""Validate entered path.
It can be regular path - in that case we test if it does exist.
It can also be mongodb connection string. In that case we parse it
as url (it should start with `mongodb://` url schema.
Args:
path (str): path, connection string url or pype token.
pos (int): current position.
Todo:
It can also be Pype token, binding it to Pype user account.
"""
if path.startswith("mongodb"):
pos = len(path)
return self._return_state(
QValidator.State.Intermediate, "", path, pos)
if len(path) < 6:
return self._return_state(
QValidator.State.Intermediate, "", path, pos)
valid, reason = validate_path_string(path)
if not valid:
return self._return_state(
QValidator.State.Invalid, reason, path, pos)
else:
return self._return_state(
QValidator.State.Acceptable, reason, path, pos)
if __name__ == "__main__":
app = QtWidgets.QApplication(sys.argv)
d = InstallDialog()

61
igniter/install_thread.py
View file

@ -1,30 +1,43 @@
# -*- coding: utf-8 -*-
"""Working thread for installer."""
import sys
import os
from Qt.QtCore import QThread, Signal
from pype import settings
from igniter.tools import load_environments
from .bootstrap_repos import BootstrapRepos
class InstallThread(QThread):
"""Install Worker thread.
progress = Signal(int)
message = Signal((str, bool))
_path = None
This class takes care of finding Pype version on user entered path
(or loading this path from database). If nothing is entered by user,
Pype will create its zip files from repositories that comes with it.
If path contains plain repositories, they are zipped and installed to
user data dir.
Attributes:
progress (Signal): signal reporting progress back o UI.
message (Signal): message displaying in UI console.
"""
def __init__(self, parent=None):
self.progress = Signal(int)
self.message = Signal((str, bool))
self._path = None
QThread.__init__(self, parent)
def run(self):
self.message.emit("Installing Pype ...", False)
# find local version of Pype
bs = BootstrapRepos()
local_version = bs.get_local_version()
if getattr(sys, "freeze", None):
# copy frozen repo zip
pass
else:
# we are running from live code.
# if user did entered nothing, we install Pype from local version.
# zip content of `repos`, copy it to user data dir and append
# version to it.
if not self._path:
@ -37,6 +50,38 @@ class InstallThread(QThread):
f"!!! install failed - {repo_file}", True)
return
self.message.emit(f"installed as {repo_file}", False)
else:
pype_path = None
# find central pype location from database
if self._path.startswith("mongodb"):
self.message.emit("determining Pype location from db...")
os.environ["AVALON_MONGO"] = self._path
env = load_environments()
if not env.get("PYPE_ROOT"):
self.message.emit(
"!!! cannot load path to Pype from db", True)
return
self.message.emit(f"path loaded from database ...", False)
self.message.emit(env.get("PYPE_ROOT"), False)
if not os.path.exists(env.get("PYPE_ROOT")):
self.message.emit(f"!!! path doesn't exist", True)
return
pype_path = env.get("PYPE_ROOT")
if not pype_path:
pype_path = self._path
if not os.path.exists(pype_path):
self.message.emit(f"!!! path doesn't exist", True)
return
# detect Pype in path
def set_path(self, path: str) -> None:
self._path = path

68
igniter/tools.py
View file

@ -1,37 +1,60 @@
# -*- coding: utf-8 -*-
"""Tools used in **Igniter** GUI."""
import sys
import os
import uuid
from pype.lib import decompose_url, compose_url
from urllib.parse import urlparse
from pymongo import MongoClient
from pymongo.errors import ServerSelectionTimeoutError
from pymongo.errors import ServerSelectionTimeoutError, InvalidURI
def validate_mongo_connection(cnx: str) -> (bool, str):
parsed = urlparse(cnx)
if parsed.scheme in ["mongodb", "mongodb+srv"]:
# we have mongo connection string. Let's try if we can connect.
components = decompose_url(cnx)
mongo_args = {
"host": compose_url(**components),
"serverSelectionTimeoutMS": 1000
}
port = components.get("port")
if port is not None:
mongo_args["port"] = int(port)
try:
client = MongoClient(**mongo_args)
# client.server_info()
except ServerSelectionTimeoutError as e:
return False, f"Cannot connect to server {cnx} - {e}"
except ValueError:
return False, f"Invalid port specified {parsed.port}"
except InvalidURI as e:
return False, str(e)
else:
return True, "Connection is successful"
else:
return False, "Not mongodb schema"
def validate_path_string(path: str) -> (bool, str):
"""Validate string if it is acceptable by Igniter.
"""Validate string if it is acceptable by **Igniter**.
``path` string can be either regular path, or mongodb url or Pype token.
`path` string can be either regular path, or mongodb url or Pype token.
Args:
path (str): String to validate.
Returns:
(bool, str): True if valid, False if not and in second part of tuple
(bool, str):
True if valid, False if not and in second part of tuple
the reason why it failed.
"""
parsed = urlparse(path)
if parsed.scheme == "mongodb":
# we have mongo connection string. Let's try if we can connect.
client = MongoClient(path, serverSelectionTimeoutMS=1)
try:
client.server_info()
except ServerSelectionTimeoutError:
return False, "Cannot connect to server"
else:
return True, "Connection is successful"
return validate_mongo_connection(path)
# test for uuid
try:
uuid.UUID(path)
@ -44,3 +67,22 @@ def validate_path_string(path: str) -> (bool, str):
# we have pype token
# todo: implement
return False, "Not implemented yet"
def load_environments() -> dict:
try:
import acre
except ImportError:
sys.path.append("repos/acre")
import acre
from pype import settings
all_env = settings.environments()
merged_env = {}
for _, v in all_env.items():
if isinstance(v, dict):
parsed_env = acre.parse(v)
merged_env = acre.append(merged_env, parsed_env)
env = acre.compute(merged_env, cleanup=True)
return env

101
pype.py
View file

@ -40,23 +40,44 @@ import sys
import os
import re
import traceback
import platform
from pathlib import Path
from igniter.tools import load_environments
try:
import acre
except ImportError:
sys.path.append("repos/acre")
import acre
from igniter import BootstrapRepos
# find Pype installation.
from igniter.bootstrap_repos import BootstrapRepos
bootstrap = BootstrapRepos()
pype_versions = bootstrap.find_pype()
# if nothing found, run installer - only when running frozen
if getattr(sys, 'frozen', False):
if not pype_versions:
import igniter
igniter.run()
def set_environments() -> None:
env = load_environments()
env = acre.merge(env, dict(os.environ))
os.environ.clear()
os.environ = env
def boot():
"""Bootstrap Pype."""
art = r"""
____________
/\ ___ \
\ \ \/_\ \
\ \ _____/ ______ ___ ___ ___
\ \ \___/ /\ \ \ \\ \\ \
\ \____\ \ \_____\ \__\\__\\__\
\/____/ \/_____/ . PYPE Club .
"""
print(art)
print(">>> loading environments ...")
set_environments()
# find pype versions
bootstrap = BootstrapRepos()
pype_versions = bootstrap.find_pype()
# check for `--use-version=3.0.0` argument.
use_version = None
@ -66,19 +87,30 @@ def boot():
use_version = m.group('version')
break
if not os.getenv("AVALON_MONGO"):
print("*** No DB connection string specified.")
import igniter
igniter.run()
set_environments()
if getattr(sys, 'frozen', False):
if not pype_versions:
import igniter
igniter.run()
if use_version in pype_versions.keys():
# use specified
bootstrap.add_paths_from_archive(pype_versions[use_version])
os.environ["PYPE_ROOT"] = pype_versions[use_version]
use_version = pype_versions[use_version]
else:
if use_version is not None:
print(("!!! Specified version was not found, using "
"latest available"))
# use latest
bootstrap.add_paths_from_archive(list(pype_versions.values())[-1])
os.environ["PYPE_ROOT"] = list(pype_versions.values())[-1]
use_version = list(pype_versions.keys())[-1]
os.environ["PYPE_ROOT"] = pype_versions[use_version].as_posix()
else:
# run through repos and add them to sys.path and PYTHONPATH
pype_root = os.path.dirname(os.path.realpath(__file__))
@ -104,22 +136,8 @@ def boot():
from pype.lib import terminal as t
from pype.version import __version__
art = r"""
____________
/\ ___ \
\ \ \/_\ \
\ \ _____/ ______ ___ ___ ___
\ \ \___/ /\ \ \ \\ \\ \
\ \____\ \ \_____\ \__\\__\\__\
\/____/ \/_____/ . PYPE Club .
"""
print(art)
t.echo(f"*** Pype [{__version__}] --------------------------------------")
t.echo(">>> Using Pype from [ {} ]".format(os.path.dirname(cli.__file__)))
t.echo(">>> Loading environments ...")
load_environments()
print_info()
try:
@ -140,12 +158,11 @@ def print_info() -> None:
components = get_default_components()
infos = []
if os.getenv('PYPE_DEV'):
if not getattr(sys, 'frozen', False):
infos.append(("Pype variant", "staging"))
else:
infos.append(("Pype variant", "production"))
infos.append(("Running pype from", os.environ.get('PYPE_SETUP_PATH')))
infos.append(("Using config at", os.environ.get('PYPE_CONFIG')))
infos.append(("Running pype from", os.environ.get('PYPE_ROOT')))
infos.append(("Using mongodb", components["host"]))
if os.environ.get("FTRACK_SERVER"):
@ -175,28 +192,4 @@ def print_info() -> None:
t.echo("... {}:{}[ {} ]".format(info[0], " " * padding, info[1]))
print('\n')
def load_environments() -> None:
import acre
os.environ['PLATFORM'] = platform.system().lower()
# FIXME (antirotor): Acre cannot read stuff from zip files.
os.environ["TOOL_ENV"] = os.path.join(
os.environ["PYPE_ROOT"],
"pype-config",
"environments"
)
tools_env = acre.get_tools(
["global", "avalon", "ftrack", "deadline", "clockify"])
pype_paths_env = dict()
for key, value in dict(os.environ).items():
if key.startswith('PYPE_'):
pype_paths_env[key] = value
env = tools_env
env.update(pype_paths_env)
env = acre.compute(env, cleanup=True)
env = acre.merge(env, os.environ)
os.environ = env
boot()

12
pype/api.py
View file

@ -3,15 +3,14 @@ from .settings import (
project_settings,
environments
)
from pypeapp import (
Logger,
from .lib import (
PypeLogger,
Anatomy,
project_overrides_dir_path,
config,
execute
)
from pypeapp.lib.mongo import (
from .lib.mongo import (
decompose_url,
compose_url,
get_default_components
@ -58,9 +57,8 @@ __all__ = [
"project_settings",
"environments",
"Logger",
"PypeLogger",
"Anatomy",
"project_overrides_dir_path",
"config",
"execute",
"decompose_url",
@ -82,8 +80,6 @@ __all__ = [
"RepairAction",
"RepairContextAction",
"Logger",
"ValidationException",
# get contextual data

2
pype/hosts/harmony/__init__.py
View file

@ -62,7 +62,7 @@ def get_asset_settings():
"resolutionHeight": resolution_height
}
harmony_config = config.get_presets().["harmony"]["general"]
harmony_config = config.get_presets()["harmony"]["general"]
skip_resolution_check = harmony_config.get(["skip_resolution_check"], [])
if os.getenv('AVALON_TASK') in skip_resolution_check:

4
pype/lib/__init__.py
View file

@ -20,6 +20,7 @@ from .mongo import (
from .user_settings import IniSettingRegistry
from .user_settings import JSONSettingRegistry
from .user_settings import PypeSettingsRegistry
terminal = Terminal
@ -38,5 +39,6 @@ __all__ = [
compose_url,
get_default_components,
IniSettingRegistry,
JSONSettingRegistry
JSONSettingRegistry,
PypeSettingsRegistry
]

72
pype/lib/execute.py
View file

@ -1,32 +1,35 @@
import subprocess
import os
import logging
from .log import PypeLogger as Logger
log = logging.getLogger(__name__)
def execute(args,
silent=False,
cwd=None,
env=None,
shell=None):
""" Execute command as process.
"""Execute command as process.
This will execute given command as process, monitor its output
and log it appropriately.
.. seealso:: :mod:`subprocess` module in Python
.. seealso:: :mod:`subprocess` module in Python.
Args:
args (list): list of arguments passed to process.
silent (bool): control output of executed process.
cwd (str): current working directory for process.
env (dict): environment variables for process.
shell (bool): use shell to execute, default is no.
Returns:
int: return code of process
:param args: list of arguments passed to process
:type args: list
:param silent: control ouput of executed process
:type silent: bool
:param cwd: current working directory for process
:type cwd: string
:param env: environment variables for process
:type env: dict
:param shell: use shell to execute, default is no
:type shell: bool
:returns: return code of process
:rtype: int
"""
log_levels = ['DEBUG:', 'INFO:', 'ERROR:', 'WARNING:', 'CRITICAL:']
@ -63,3 +66,44 @@ def execute(args,
popen.wait()
return popen.returncode
def _subprocess(*args, **kwargs):
"""Convenience method for getting output errors for subprocess.
.. seealso:: :mod:`subprocess`
"""
# make sure environment contains only strings
if not kwargs.get("env"):
filtered_env = {k: str(v) for k, v in os.environ.items()}
else:
filtered_env = {k: str(v) for k, v in kwargs.get("env").items()}
# set overrides
kwargs['stdout'] = kwargs.get('stdout', subprocess.PIPE)
kwargs['stderr'] = kwargs.get('stderr', subprocess.STDOUT)
kwargs['stdin'] = kwargs.get('stdin', subprocess.PIPE)
kwargs['env'] = filtered_env
proc = subprocess.Popen(*args, **kwargs)
output, error = proc.communicate()
if output:
output = output.decode("utf-8")
output += "\n"
for line in output.strip().split("\n"):
log.info(line)
if error:
error = error.decode("utf-8")
error += "\n"
for line in error.strip().split("\n"):
log.error(line)
if proc.returncode != 0:
raise ValueError(
"\"{}\" was not successful:\nOutput: {}\nError: {}".format(
args, output, error))
return output

Some files were not shown because too many files have changed in this diff Show more