x/opencafe
Code Issues Proposed changes
Files
master
opencafe/docs/source/getting_started/install.rst
John Vrbanac 916d666923 Taking a quick stab at the install docs. 
Will need to add more here, but this will get us started.

Closes GitHub Issue #7
Change-Id: Ieac7bc0e3f21e1df9cc63c91c3a8b62371b94e82
2014-02-06 18:01:22 -06:00

1.1 KiB
Raw Permalink Blame History

Installing OpenCAFE

Currently OpenCAFE is not available on PyPI (coming soon). As a result, you will need to install via pip through either cloning the repository or downloading a snapshot archive.

Install OpenCAFE

The preferred method of installing OpenCAFE is using pip.

# Clone Repository
git clone git@github.com:CafeHub/opencafe.git

# Change current directory
cd opencafe

# Install OpenCAFE
pip install . --upgrade

If you don't wish to use Git, then you can download and uncompress a snapshot archive in place of cloning the repository.

Installing Plugins

When you install OpenCAFE, you only install the base framework. All other functionality is packaged into plugins.

Install

To install a plugin, use the following command:

# Installing the mongo plugin
cafe-config plugins install mongo

List

Retrieves a list of all plugins available to install

cafe-config plugins list