.. include:: headings.inc

.. module:: tools.Editra.setup

.. currentmodule:: tools.Editra.setup

.. highlight:: python



.. _tools.Editra.setup:

==========================================================================================================================================
|phoenix_title|  **setup**
==========================================================================================================================================

Editra Setup Script

USAGE:

  1) Windows:
     - python setup.py py2exe

  2) MacOSX:
     - python setup.py py2app

  3) Boil an Egg
     - python setup.py bdist_egg

  4) Install as a python package
     - python setup.py install
           - '--no-clean' can be specified to skip old file cleanup


**Summary:**  Used for building the editra distribution files and installations


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~tools.Editra.setup.BuildECLibDemo`                                       Build the Editra Control Library Demo package
:func:`~tools.Editra.setup.BuildOSXApp`                                          Build the OSX Applet
:func:`~tools.Editra.setup.BuildPy2Exe`                                          Generate the Py2exe files
:func:`~tools.Editra.setup.CleanBuild`                                           Cleanup all build related files
:func:`~tools.Editra.setup.CreateDMG`                                            Create an OSX DMG
:func:`~tools.Editra.setup.DoSourcePackage`                                      Build a source package or do a source install
:func:`~tools.Editra.setup.GenerateBinPackageFiles`                              Generate the list of files needed for py2exe/py2app package files
:func:`~tools.Editra.setup.GenerateSrcPackageFiles`                              Generate the list of files to include in a source package dist/install
:func:`~tools.Editra.setup.Log`                                                  Write to the build log
================================================================================ ================================================================================


|



Functions
------------

.. function:: BuildECLibDemo()

   Build the Editra Control Library Demo package


.. function:: BuildOSXApp()

   Build the OSX Applet


.. function:: BuildPy2Exe()

   Generate the Py2exe files


.. function:: CleanBuild()

   Cleanup all build related files


.. function:: CreateDMG(version)

   Create an OSX DMG
   
   :param version: version number string
   
   .. todo::  cleanup and generalize


.. function:: DoSourcePackage()

   Build a source package or do a source install


.. function:: GenerateBinPackageFiles()

   Generate the list of files needed for py2exe/py2app package files


.. function:: GenerateSrcPackageFiles()

   Generate the list of files to include in a source package dist/install


.. function:: Log(msg)

   Write to the build log