Skip to content

Creating a development environment to work with Meniscus

Chad Lung edited this page Jan 7, 2014 · 15 revisions

Prerequisites

Note: We are assuming that you are using Ubuntu Linux, OS X will work but you will need to make some changes.

  • Install Python 2.7.5 or newer using pyenv and following their instructions.
  • Once pyenv and Python 2.7.5+ are installed and working correctly install Virtualenv
  • Install a Git client, GitHub does offer a decent Git GUI client for Mac. On Ubuntu Linux you can do the following:
$ sudo apt-get update
$ sudo apt-get install git-core

Create the Virtualenv folder for the project and clone the source code

From the command line in a folder you want the project stored:

$ virtualenv projectmeniscus-main-repo
$ cd ProjectMeniscus
$ source bin/activate
$ mkdir src && cd src
$ git clone "https://github.com/ProjectMeniscus/meniscus.git"
$ cd meniscus
$ pip install -r tools/pip-requires
$ pip install -r tools/test-requires

The virtualenv is now created and you have the latest source code and required libraries.

To activate and deactivate the virtualenv simply use the following commands.

To activate from the projectmeniscus-main-repo folder:

$ source bin/activate

To deactivate (from any folder under projectmeniscus-main-repo):

$ source deactivate