blob: c1acba16b9870ec572e56edea4fbb5874bb6ac86 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# genenetwork3
GeneNetwork3 REST API for data science and machine learning
## Installation
#### Using guix
Simply load up the environment (for development purposes):
```bash
guix environment --load=guix.scm
```
Also, make sure you have the *guix-bioinformatics* channel set up.
```bash
env GUIX_PACKAGE_PATH=~/guix-bioinformatics/ ~/.config/guix/current/bin/guix environment --load=guix.scm
python3
import redis
```
Better run a proper container
```
env GUIX_PACKAGE_PATH=~/guix-bioinformatics/ ~/.config/guix/current/bin/guix environment -C --network --load=guix.scm
```
#### Running Tests
(assuming you are in a guix container; otherwise use venv!)
To run tests:
```bash
python -m unittest discover -v
```
Running pylint:
```bash
pylint *py tests gn3
```
Running mypy(type-checker):
```bash
mypy .
```
#### Running the flask app
To spin up the server:
```bash
env FLASK_DEBUG=1 FLASK_APP="main.py" flask run --port=8080
```
##### Using python-pip
IMPORTANT NOTE: we do not recommend using pip tools, use Guix instead
1. Prepare your system. You need to make you have python > 3.8, and
the ability to install modules.
2. Create and enter your virtualenv:
```bash
virtualenv --python python3 venv
. venv/bin/activate
```
3. Install the required packages
```bash
# The --ignore-installed flag forces packages to
# get installed in the venv even if they existed
# in the global env
pip install -r requirements.txt --ignore-installed
```
#### A note on dependencies
Make sure that the dependencies in the `requirements.txt` file match those in
guix. To freeze dependencies:
```bash
# Consistent way to ensure you don't capture globally
# installed packages
pip freeze --path venv/lib/python3.8/site-packages > requirements.txt
```
|
