Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.55 KB

INSTALLATION.md

File metadata and controls

54 lines (40 loc) · 2.55 KB

Development

There are several methods for building and setting up a development environment.

Manual Method

  1. Create a new virtualenv with Python 3.6 (virtualenv --python=<path-to-py3> venv) and source it
  2. Install requirements via pip. For the moment there are two options:
    • Install with plain pip using the requirements
    • Install using Pipenv (which reads from the Pipfile)
  3. Build nativepython libraries using python setup.py build
  4. Append the root of this repository to your PYTHONPATH

Pipenv Method

This method is simple, and can take care of virtual environment creation and installation for you.

  1. (Optional) Create a new virtualenv with Python 3.6 (virtualenv --python=<path-to-py3> venv) and source it. If you choose to use Pipenv alone, it will create an appropriate virtualenv for you.
  2. Run pipenv install --dev --deploy

Makefile Method

The included Makefile in this repository contains recipes for building, installing, and testing. For the moment, it is explicitly linked to a specific Python interpreter, so if you are using, say, an interpreter called python3.6 (as opposed to python3), you will need to change the PYTHON variable at the top of the Makefile.

You can also customize the name and location of any built virtual environments with the VIRTUAL_ENV variable.

Installation

OSX

Prerequisites

  • Python 3.6 (recommended installed with homebrew)
    • Currently build is tested against clang, not gcc. For more information about installing clang and configuring your environment see here
  • It is recommended you use Pipenv (see this link) to manage the application.
    • You can also use virtualenv.
  • install Redis (brew install redis)

Linux

(These instructions are only for Ubuntu for the moment)

Prerequisites

Before building the modules in this repository, you will need to make sure that you have the following:

  • Python 3.6 with header files (python3.6-dev python3.6-dbg) Note that for development you will also install the debug interpreter. If you are using Ubuntu 16 or earlier, you will first need to add the following PPA: 
    sudo add-apt-repository ppa:jonathonf/python-3.6
    Then run as normal: 
    sudo apt install python3.6-dev python3.6-dbg
  • Pipenv (see this link)
  • Redis Server (redis-server)