Table Of Contents

TurboGears Entry Point list

The following is a list of setuptools entry points used by the TurboGears framework.


Entry point for TurboGears quickstart templates. Please read how to create your own quickstart templates on the page about extending quickstart.


Entry point for Python template engine plugins, like TurboKid, TurboCheetah and TurboJson. For information on writing a template engine plugin, see Writing a Template Engine.


This entry point is used for extensions to the tg-admin utility. The tg-admin utility expects that the provided object is a class which has a desc attribute and a run() method. It can also have an optional need_project attribute, which if set to True will cause the command to fail unless it is being run from the root folder of a project. Below is a sample do-nothing class that correctly implements a tg-admin command.:

class Sample:
    desc = "This is a sample class which must be run in a project"
    need_project = True
    def __init__(self, version):

    def run(self):

Detailed information can be found on the about tg-admin Command Plugins.


This entry point is used for extensions to the identity system. New authentication providers can be used to allow authentication against a variety of sources.


This entry point is for TurboGears extension components that hook into the TurboGears server when it starts up. Examples are the visit and identity frameworks and the TurboMail extension.


This entry point is used for extensions to the visit system. You can register a visit manager plugin here, and enable it through the visit configuration. This allows, for example, to use different storage backends for visit objects or perform housekeeping tasks, e.g. cleaning up old visits etc.

The visit framework provides its own plugin mechanism for plugins which are called on every request. See Extending the Visit Framework for more information.


The turbogears.toolboxcommand entry point defines items that are available on the Toolbox, the web application that is launched by the tg-admin toolbox command.