carbon / travel-carbon-footprint.irap.omp.eu

Commit 6e04d5e561826e7a03a5a829261f89b99f0d102f

Authored by Antoine Goutenoir
1 parent 8a56259b
Exists in master

docs: update the README to mention python 3

Showing 1 changed file with 12 additions and 9 deletions   Show diff stats
Inline Side-by-side
README.md
  Diff comments   View file @6e04d5e
... ... @@ -2,7 +2,7 @@
2 2 # Travel Carbon Footprint Calculator
3 3  
4 4 - https://travel-footprint-calculator.apps.goutenoir.com (private demo)
5   -- http://travel-footprint-calculator.irap.omp.eu (official, for later)
  5 +- http://travel-footprint-calculator.irap.omp.eu (official)
6 6  
7 7  
8 8 ## Overview
... ... @@ -16,20 +16,25 @@
16 16  
17 17 ## Installation
18 18  
19   -Tested only on Python `2.7`. _Sprint._
  19 +Works on Python `2.7` up to `1.2` version.
  20 +Works on Python `3.7` from `1.3` version.
  21 +
20 22  
21 23 ### Create a virtual environment
22 24  
23 25 You don't _have to_. But it's useful for development.
24 26  
25   - virtualenv venv
  27 + virtualenv .venv
26 28  
27 29 Then, source it to enable it.
28 30  
29   - source venv/bin/activate
  31 + source .venv/bin/activate
30 32  
31 33 ### Install the python dependencies
32 34  
  35 +You will need Cython.
  36 +
  37 + sudo apt install cython
33 38 pip install -r requirements.txt
34 39  
35 40 ### Create an empty database
... ... @@ -44,18 +49,16 @@ Then, source it to enable it.
44 49 ### Configure permissions
45 50  
46 51 `var/runs` must be writeable by the application.
  52 +It is the file-based part of the database.
47 53  
48   -
49   -## Build CSS and JS ()for prod)
  54 +## Build CSS and JS (for prod)
50 55  
51 56 flask assets build
52 57  
53 58  
54   -
55   -
56 59 ## Development
57 60  
58   - source venv/bin/activate
  61 + source .venv/bin/activate
59 62 source .env.flaskrun
60 63 flask run
61 64  
... ...