Package: colony
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 startHandicraftInstall Colony usingpip install colonyRun the commandRUN_MODE=devel colonyVirtualenvStart and activate the environment usingvirtualenv .venv && source .venv/bin/activateInstall Colony in the system usingpip install colonyDeploy the console package usingcpm install console_interfaceRun your new colony using the commandRUN_MODE=devel colonyDockerCreate a new directory to serve as the base for the buildmkdir colony && cd colonyRetrieve theDockerfilefrom the repo usingwget https://github.com/hivesolutions/colony/raw/master/assets/docker/DockerfileCreate the new docker image usingdocker build --tag self/colony .Execute colony withdocker run -e RUN_MODE=devel -i -t self/colonyTo actually do something useful, look intoHow to Establish your Colony in 3 Easy StepsInstallationFor developmentSetPYTHONPATHto thecolony/srcpath so that the Python source files may be includedSetPATHto thecolony/scripts/pypito use the provided base scriptsFor productionInstallation via pip:pip install colonyConfigurationNameTypeDefaultDescriptionRUN_MODEstrdevelopmentThe mode in which the Colony will be running.LOGGING_LOGSTASHboolFalseIf theLogstashlogging adapter should be enabled.UsageMost of the colony operations are run through thecpmcommand:cpm clone <target>- clones the base colony instance into the target directory (new project)cpm cleanup <target>- cleans the current instance, removing extra filescpm pack <target>- packs the current instance into a .zip filecpm generate [target] <...>- generates a .json descriptor file for the provided Python file and then runs
the build operation for the generated .json file, effectively building the package itemcpm build [descriptor] <...>- builds the target .json descriptor file into a package filecpm deploy [package]- deploys the target .cbx file into the current instancecpm info [package]- prints information about the package to the standard outputcpm install [name] <...>- installs the package with the provided name from the remote repositoriescpm upgrade- updates the complete set of packages deployed in the instancecpm require [path] <...>- installs the complete set of packages defined in the requirements filecpm upload [target] <repo>- generates a package for the provided path and then uploads it to the currently
configured primary repository or another repository if definedTestingTo run the complete set of available tests for the deployment, use eithercolony testorMODE=test colonyand Colony Manager will boot directly to unit testing and exit in error in
case at least one test fails.FeaturesRuntime modularity.No restart is required for deploying new plugins or updating or reconfiguring existing ones.Simplified component model (easy to create a plugin, even easier to combine existing ones).Capabilities: simple extension points that allow your plugins to take advantage of future plugins that adhere to the capability API.Dependencies: simplified dependency management, declare the id of the plugin your plugin needs to function, and the plugin manager
will ensure your plugin only gets loaded when the conditions are met.Most importantly, runsColony Plugins.And remember, this is just the base runtime. To understand what you can do with Colony,
browse theColony Plugins repository.ContributingAlthough Colony is still in an early stage, we're welcoming help for all kinds of work.
The best ways to get involved:Join themailing list.Send pull requests for bug fixes or new features and improvements.Help make thedocsbetter.ExtensionsTo find the Python native extension required for some of the plugins, use the following sites:Python Imaging Library (PIL)link.Reportlab PDF Generatorlink.Unofficial Windows Binaries for Python Extension Packageslink.MySQL driver for Pythonlink.Project informationColony Base Source:https://github.com/hivesolutions/colonyColony Base Plugins Source:https://github.com/hivesolutions/colony_pluginsWeb:http://getcolony.comDocs:http://getcolony.com/docs/colony/Mailing list:http://groups.google.com/group/colony-usersTwitter:http://twitter.com/colonyframeworkLicenseColony is an open-source project currently licensed under theApache License, Version 2.0.Build Automation