Colony Framework
Project description
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.
Quick start
Handicraft
- Install Colony using
pip install colony - Run the command
RUN_MODE=devel colony
Virtualenv
- Start and activate the environment using
virtualenv venv && source venv/bin/activate - Install Colony in the system using
pip install colony - Deploy the console package using
cpm install console_interface - Run your new colony using the command
RUN_MODE=devel colony
Docker
- Create a new directory to serve as base for the build
mkdir colony && cd colony - Retrieve the
Dockerfilefrom the repo usingwget https://github.com/hivesolutions/colony/raw/master/assets/docker/Dockerfile - Create the new docker image using
docker build --tag self/colony . - Execute colony with
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
Installation
For development
- Set
PYTHONPATHto thecolony/srcpath so that the Python source files may be included - Set
PATHto thecolony/scripts/pypito used the provided base scripts
For production
Usage
Most of the colony operation are run through the cpm command:
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 build 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 defined
Testing
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.
Features
- Runtime modularity.
- No restart required for deploying new plugins, updating or reconfiguring existing ones.
- Simplified component model (easy to create a plugin, even easier to combine existing ones).
- Capabilities: simple extension points which allow your plugins to take advantage of future plugins which adhere to the capability API.
- Dependencies: simplified dependency management, just declare the id of the plugin your plugin needs in order to function and the plugin manager will ensure your plugin only gets loaded when the conditions are met.
- Most importantly, runs Colony Plugins.
And remember this is just the base runtime, to understand the kind of things you can do with Colony, browse the Colony Plugins repository.
Contributing
Although Colony is still in an early stage we're welcoming help for all kinds of work. The best ways to get involved:
- Join the mailing list.
- Send pull requests for bug fixes or new features and improvements.
- Help make the docs better.
Extensions
To find Python native extension required for some of the plugins used the following sites:
- Python Imaging Library (PIL) link.
- Reportlab PDF Generator link.
- Unofficial Windows Binaries for Python Extension Packages link.
- MySQL driver for Python link.
Project information
- Colony Base Source: https://github.com/hivesolutions/colony
- Colony Base Plugins Source: https://github.com/hivesolutions/colony_plugins
- Web: http://getcolony.com
- Docs: http://getcolony.com/docs/colony/
- Mailing list: http://groups.google.com/group/colony-users
- Twitter: http://twitter.com/colonyframework
License
Colony is an open-source project currently licensed under the Apache License, Version 2.0.
Build Automation
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for colony-1.4.14-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 16ea4f64982c329d4db62c9453f9a57d54703d077123400eed3eeea503f77ea4 |
|
| MD5 | 861480caddbada233dcb6af5d315a865 |
|
| BLAKE2b-256 | cc85915954391401615391e9e97d313b3d75dcc3bc4ec5a2ab85c6959165f796 |
