From 916d666923ad4c9a6864fe382d361bda93d7bc4b Mon Sep 17 00:00:00 2001 From: John Vrbanac Date: Fri, 31 Jan 2014 17:46:20 -0600 Subject: [PATCH] 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 --- docs/source/getting_started/install.rst | 41 +++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/source/getting_started/install.rst b/docs/source/getting_started/install.rst index b36e187..ca93f2d 100644 --- a/docs/source/getting_started/install.rst +++ b/docs/source/getting_started/install.rst @@ -2,3 +2,44 @@ 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. + +.. code-block:: bash + + # 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: + +.. code-block:: bash + + # Installing the mongo plugin + cafe-config plugins install mongo + +List +--------- +Retrieves a list of all plugins available to install + +.. code-block:: bash + + cafe-config plugins list