About cartoloco-server

Find the direct routes available from a train station, and provide informations about the routes : trip duration, type of train, frequency.

It is recommended to be used with the map frontend cartoloco.

Data sources

Public datasets from SNCF available on data.sncf.com :

• https://data.sncf.com/explore/dataset/horaires-des-train-voyages-tgvinouiouigo
• https://data.sncf.com/explore/dataset/sncf-intercites-gtfs
• https://data.sncf.com/explore/dataset/sncf-ter-gtfs

Prerequisites

Python 3, pip and venv.

Install and run

Development

Generate and activate a venv :

python3 -m venv env 
. venv/bin/activate

Once in the venv, install dependencies :

pip install pip-tools
pip-compile # generate requirements.txt from requirements.in
pip-sync    # add / delete packages according to requirements.txt

Then start flask embeded server :

./commands/bash/start.sh

Server starts on port 5000. However, you need to prepare the database first during the first install :

./commands/bash/db-init.sh
./commands/bash/db-load-data.sh
./commands/bash/db-generate-trips.sh

Now you're ready to go ! Browse to http://localhost:5000/trips/search/bordeaux to test.

Production deployement

Quick way to download, install and run with gunicorn, for the example (~3 minutes).

Make sure to have Python3, pip, venv available before running.

git clone [email protected]:ibcht/cartoloco-server.git
cd cartoloco-server
python3 -m venv venv
. venv/bin/activate
pip install wheel gunicorn
pip install .
export FLASK_APP=tchou
flask db:init # initialize database
flask db:load-data # load GTFS data 
flask db:generate-trips # trips calculation
gunicorn -w 4 'tchou:create_app()' # run webserver

Warning : this will create a sqlite3 database in the venv tchou instance by default, which is not recommended. See the Configuration section to customize this.

Configure

Run the app with the environment variable TCHOU_SETTINGS=/path/to/config.py (absolute path only), so you can override the default configuration.

Configuration available :

DATABASE='/path/to/tchou.sqlite' #absolute path only
SECRET_KEY='dev'
ALLOW_ORIGIN='http://front-end-server.com' # Access-Control-Allow-Origin header value
# to be continued ...