Metadata-Version: 2.1
Name: tpdcclib
Version: 0.0.1
Summary: Collection of Python modules to write DCC tools in a DCC agnostic way.
Home-page: https://github.com/tpoveda/tpDccLib
Author: Tomas Poveda
Author-email: tpovedatd@gmail.com
License: MIT
Platform: UNKNOWN
Description-Content-Type: text/x-rst
Provides-Extra: dev
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

tpDccLib
============================================================

.. image:: https://img.shields.io/github/license/tpoveda/tpDccLib.svg
    :target: https://github.com/tpoveda/tpPyUtils/blob/master/LICENSE

Collection of Python modules to write DCC tools in a DCC agnostic way.

When working with specific DCCs, tpDccLib will auto import proper modules and will use
DCC specific implementations.

Installation
-------------------
Manual
~~~~~~~~~~~~~~~~~~~~~~
1. Clone/Download tpDccLib anywhere in your PC (If you download the repo, you will need to extract
the contents of the .zip file).
2. Copy **tpDccLib** folder located inside **source** folder in a path added to **sys.path**

Automatic
~~~~~~~~~~~~~~~~~~~~~~
Automatic installation for tpDccLib is not finished yet.

DCC Implementations
-------------------
At this moment following DCCs are supported:

* **3ds Max**: https://github.com/tpoveda/tpMaxLib
* **Maya**: https://github.com/tpoveda/tpMayaLib
* **Houdini**: https://github.com/tpoveda/tpHoudiniLib
* **Nuke**: https://github.com/tpoveda/tpNukeLib
* **Blender**: *Work in Progress*

During tpDccLib initialization, if DCC specific implementation package is found in sys.path, tpDccLib
will automatically detect it and will import it.

Usage
-------------------
Initialization Code
~~~~~~~~~~~~~~~~~~~~~~
tpDccLib must be initialized before being used.

.. code-block:: python

    import tpDccLib
    tpDccLib.init()


Reloading
~~~~~~~~~~~~~~~~~~~~~~
For development purposes, you can enable reloading system, so 
you can reload tpDccLib sources without the necessity of restarting
your Python session. Useful when working with DCCs.

.. code-block:: python

    import tpDccLib
    reload(tpDccLib)
    tpDccLib.init(True)


Enabling debug log
~~~~~~~~~~~~~~~~~~~~~~
By default, tpDccLib logger only logs warning messages. To enable all log messages
you can set TPDCCLIB_DEV environment variables to 'True'

.. code-block:: python

    import os

    os.environ['TPDCCLIB_DEV'] = 'True'
    import tpDccLib
    tpDccLib.init()

