The Colony Framework is an open source plugin framework specification. Implementations of the specification offer a runtime component model, that allows for plugins to be installed, started, stopped, updated and uninstalled without requiring the application container to be stopped. The specification relies heavily on the Inversion of control principle, in order to make it easier for application components to discover and interact with each other.
Colony aims to eliminate the complexity typically associated with the creation of modular applications, through a simplified unified model for component development. Practical applications can range from modular enterprise software to application mashing.
pip install colony
virtualenv venv && source venv/bin/activate
pip install colony
cpm install console_interface
mkdir colony && cd colony
Dockerfilefrom the repo using
docker build --tag self/colony .
docker run -e RUN_MODE=devel -i -t self/colony
To actually do something useful look into How to Establish your Colony in 3 Easy Steps
colony/srcpath so that the Python source files may be included
colony/scripts/pypito used the provided base scripts
Most of the colony operation are run through the
cpm clone <target>- clones the base colony instance into the target directory (new project)
cpm cleanup <target>- cleans the current instance removing extra files
cpm pack <target>- packs the current instance into a .zip file
cpm generate [target] <...>- generates a .json descriptor file for the provided Python file and then runs the build operation for the generated .json file, effectively build the package item
cpm build [descriptor] <...>- builds the target .json descriptor file into a package file
cpm deploy [package]- deploys the target .cbx file into the current instance
cpm info [package]- prints information about the package to the standard output
cpm install [name] <...>- installs the package with the provided name from the remote repositories
cpm upgrade- updates the complete set of packages deployed in the instance
cpm require [path] <...>- installs the complete set of packages defined in the requirements file
cpm upload [target] <repo>- generates a package for the provided path and then uploads it to the currently configured primary repository, or another repository if defined
In order 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 the kind of things 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:
To find Python native extension required for some of the plugins used the following sites:
Colony is an open-source project currently licensed under the Apache License, Version 2.0.