• Python 3.4
• PostgreSQL 9.4 / PostGIS 2.1
• virtualenv (1.7 or higher)
• ElasticSearch 2.3.2
• Redis 2.8
• GEOS (3.4 or higher)

On Debian/Ubuntu systems the required components may be installed using

sudo apt-get install virtualenv python3-dev postgresql-9.4 postgresql-9.4-postgis-2.1 postgresql-contrib-9.4 libpq-dev libgeos-dev redis-server libffi6 libffi-dev

The Debian package for ElasticSearch can be downloaded from https://www.elastic.co/downloads/past-releases/elasticsearch-2-3-2

git clone https://github.com/c2corg/v6_api.git

cd v6_api
make -f config/{user} install

scripts/create_user_db.sh

If you want to specify a specific string as user, you can instead use:

USER=something scripts/create_user_db.sh

.build/venv/bin/initialize_c2corg_api_es development.ini

See /c2corg_api/scripts/migration/README.md.

The API consists of three applications, the actual web-application, a syncer script that synchronizes the database with ElasticSearch and a background jobs script that purges the database of non activated accounts and expired tokens. The three have to be started separately.

To start the background jobs script:

make -f config/$USER run-background-jobs

To start the syncer script:

make -f config/$USER run-syncer

In production, the scripts should be started using

make -f config/$USER run-background-jobs-prod
make -f config/$USER run-syncer-prod

To start the web-application:

make -f config/$USER serve

Open your browser at http://localhost:6543/ or http://localhost:6543/?debug (debug mode). Make sure you are using the port that is set in config/$USER.

Available actions may be listed using:

make help

Get the list of waypoints:

GET http://localhost:6543/waypoints

Get waypoint with id=1:

GET http://localhost:6543/waypoints/1

Insert a waypoint:

curl -X POST -v \
-H "Content-Type: application/json" \
-d '{"waypoint_type": "summit", "elevation": 3779, "geometry": {"geom": "{\"type\": \"Point\", \"coordinates\": [635956, 5723604]}"},"locales": [{"lang": "fr", "title": "Mont Pourri"}]}' \
http://localhost:6543/waypoints

Updating a waypoint:

curl -X PUT -v \
-H "Content-Type: application/json" \
-d '{"message": "Comment about change", "document": {"elevation": 4633, "maps_info": null, "version": 1, "document_id": 1, "waypoint_type": "summit", "locales": [{"lang": "fr", "version": 1, "title": "Mont Rose", "access": null, "description": null}]}}' \
http://localhost:6543/waypoints/1

• Simple search
• Guidebook API

See https://github.com/c2corg/v6_forum

Create a database that will be used to run the tests:

scripts/create_user_db_test.sh

If you want to specify a specific string as user you can instead enter:

USER=something scripts/create_user_db_test.sh

Then run the tests with:

make -f config/$USER test

Or with the check target, which runs flake8 and test:

make -f config/$USER check

To run a specific test:

.build/venv/bin/nosetests c2corg_api/tests/views/test_waypoint.py
.build/venv/bin/nosetests -s  c2corg_api/tests/views/test_waypoint.py:TestWaypointRest.test_get_lang

To see the debug output:

.build/venv/bin/nosetests -s

Check the Discourse forum is up and available to the client API:

scripts/check_discourse_connection.sh [id]

"id" is a v6 user id. The script should return a 200OK.

To get information about a running API instance, e.g. its version and the status of its components, the health service /health can be used:

GET http://localhost:6543/health

The API is mainly built using the following components:

• Pyramid (Python framework) http://docs.pylonsproject.org/en/latest/
• SQLAlchemy (ORM) http://docs.sqlalchemy.org/en/rel_1_0/
• Cornice (REST framework) https://cornice.readthedocs.org/en/latest/
• Colander (validating and deserializing data) http://docs.pylonsproject.org/projects/colander/en/latest/

In case of unexpected exceptions, an error handler makes sure that a JSON response is returned. During development it can be convenient to see the Pyramid debugger toolbar in case of errors. To disable the error handler, add the following line to your config config/{user}:

export show_debugger_for_errors = true