Fork me on GitHub

Colony Framework

The Colony Framework is an open-source plugin framework specification. Its implementations provide a component model at runtime, enabling plugins to be installed, started, stopped, updated, and uninstalled without having to stop the application container. The framework heavily relies on the Inversion of Control principle, making it easier for application components to discover and interact with each other.

Colony's goal is to simplify the process of creating modular applications by offering a unified, simplified model for component development. This can have practical applications in a variety of fields, ranging from modular enterprise software to application mashing.

Quick start




To actually do something useful, look into How to Establish your Colony in 3 Easy Steps


For development

For production


RUN_MODEstrdevelopmentThe mode in which the Colony will be running.
LOGGING_LOGSTASHboolFalseIf the Logstash logging adapter should be enabled.


Most of the colony operations are run through the cpm command:


To run the complete set of available tests for the deployment, use either colony test or MODE=test colony and Colony Manager will boot directly to unit testing and exit in error in case at least one test fails.


And remember, this is just the base runtime. To understand what you can do with Colony, browse the Colony Plugins repository.


Although Colony is still in an early stage, we're welcoming help for all kinds of work. The best ways to get involved:

  1. Join the mailing list.
  2. Send pull requests for bug fixes or new features and improvements.
  3. Help make the docs better.


To find the Python native extension required for some of the plugins, use the following sites:

Project information


Colony is an open-source project currently licensed under the Apache License, Version 2.0.

Build Automation

Build Status Build Status GitHub Coverage Status PyPi Status License