You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/installation.md
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,13 @@
4
4
There are several methods for building and setting up a development environment.
5
5
6
6
### Manual Method ###
7
-
1. Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it
7
+
1. Create a new virtualenv with Python 3.6 (`virtualenv --python=<path-to-py3> venv`) and source it.
8
8
2. Install requirements via pip. For the moment there are two options:
9
-
* Install with plain pip using the `requirements`
10
-
* Install using Pipenv (which reads from the Pipfile)
9
+
* Install with plain pip using `pip install -r requirements.txt`
10
+
* Install using Pipenv (which reads from the Pipfile).
11
11
3. Build nativepython libraries using `python setup.py build`
12
-
4. Append the root of this repository to your `PYTHONPATH`
12
+
4. Install typed_python in the site-packages directory using `python setup.py install`
13
+
5. Move out of the typed_python root directory, as the source files can interfere with the installed package.
13
14
14
15
### Pipenv Method ###
15
16
This method is simple, and can take care of virtual environment creation and installation for you.
@@ -21,25 +22,20 @@ The included Makefile in this repository contains recipes for building, installi
21
22
22
23
You can also customize the name and location of any built virtual environments with the `VIRTUAL_ENV` variable.
23
24
24
-
25
-
## Installation ##
25
+
## Prerequisites ##
26
26
27
27
### OSX ###
28
28
29
-
#### Prerequisites ####
30
29
* Python 3.6 (recommended installed with homebrew)
31
30
* Currently build is tested against `clang`, not `gcc`. For more information about installing `clang` and configuring your environment see [here](https://embeddedartistry.com/blog/2017/2/20/installing-clangllvm-on-osx)
32
31
* It is recommended you use Pipenv ([see this link](https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv)) to manage the application.
33
32
* You can also use virtualenv.
34
33
* install Redis (`brew install redis`)
35
34
36
35
37
-
38
-
39
36
### Linux ###
40
37
(These instructions are only for Ubuntu for the moment)
41
38
42
-
#### Prerequisites ####
43
39
Before building the modules in this repository, you will need to make sure that you have the following:
44
40
* Python 3.6 with header files (`python3.6-dev python3.6-dbg`)
45
41
Note that for development you will also install the debug interpreter.
0 commit comments