.. image:: https://img.shields.io/pypi/v/geokey.svg :alt: PyPI Package :target: https://pypi.python.org/pypi/geokey

.. image:: https://img.shields.io/travis/ExCiteS/geokey/master.svg :alt: Travis CI Build Status :target: https://travis-ci.org/ExCiteS/geokey

.. image:: https://coveralls.io/repos/ExCiteS/geokey/badge.svg?branch=master&service=github :alt: Coveralls Test Coverage :target: https://coveralls.io/github/ExCiteS/geokey?branch=master

.. image:: https://requires.io/github/ExCiteS/geokey/requirements.svg?branch=master :alt: Requirements Status :target: https://requires.io/github/ExCiteS/geokey/requirements/?branch=master

====== GeoKey

GeoKey is a platform for participatory mapping, that is developed by Extreme Citizen Science <http://ucl.ac.uk/excites>_ research group at University College London.

Install with Docker

Download and install Docker CE <https://www.docker.com/community-edition#download>_ for your platform. This will include the docker-compose command used below. (Note that when using Ubuntu, most of these commands need to be run as root or prefixed with sudo).

1. Pull and extract relevant images, build the GeoKey application container:

.. code-block:: console

docker-compose up --build

2. In another terminal window migrate the database:

.. code-block:: console

docker-compose exec geokey python manage.py migrate

3. Run the collectstatic management command:

.. code-block:: console

docker-compose exec geokey python manage.py collectstatic --noinput

4. Finally run the server:

.. code-block:: console

docker-compose exec geokey python manage.py runserver 0.0.0.0:8000

If everything went well, there should be a GeoKey instance available on your system at http://localhost:9000.

For development purposes, the source code is also mounted as a volume in the geokey container, which means that changes made to the source code on the host machine are reflected in the container.

In order for Grunt to compile the Handlebars templates within the container, in a new terminal window run:

.. code-block:: console

docker-compose exec geokey npm run grunt

Install for development

Updated documentation: The following link will direct you to the updated guide that aims to install GeoKey on a cloud server running on a Ubuntu machine, specifically version 18.04 that will be supported until 2028. This documentation aims to simplify the processes as much as possible to make it suitable for everyone including non-technical people not familiar with Python / Linux environment but keen on running GeoKey on their own cloud servers. https://github.com/ExCiteS/geokey/blob/master/GeoKey_updated_documentation.pdf

For advanced users, please follow below.

GeoKey can be run on Python 2.7 or Python 3 (Geokey 1.8 onwards).

1. Update your system:

.. code-block:: console

sudo apt-get update && sudo apt-get upgrade

2. Install PostgreSQL and PostGIS (we follow the official guides <http://trac.osgeo.org/postgis/wiki/UsersWikiPostGIS21UbuntuPGSQL93Apt>_):

.. code-block:: console

sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt wheezy-pgdg main" >> /etc/apt/sources.list'
wget --quiet -O - http://apt.postgresql.org/pub/repos/apt/ACCC4CF8.asc | sudo apt-key add -
sudo apt-get update
sudo apt-get install postgresql-9.4-postgis-2.1 postgresql-contrib postgresql-server-dev-9.4

Note that for Ubuntu 16.04, you don't need to add the repo and can install 9.5:

.. code-block:: console

sudo apt-get install postgresql-9.5-postgis-2.2 postgresql-contrib postgresql-server-dev-9.5

3. Setup all other dependencies:

.. code-block:: console

sudo apt-get install python-pip python-virtualenv python-dev libjpeg-dev libmagickcore-dev libmagickwand-dev imagemagick binutils libproj-dev libav-tools gdal-bin python-gdal

4. Change ImageMagick permissions for it to be able to write:

   sed -i 's/\(<policy domain="coder" rights=\)"none" \(pattern="PDF" \/>\)/\1"read|write"\2/g' /etc/ImageMagick-6/policy.xml

For Ubuntu you might also need to install libavcodec-extra-52 or libavcodec-extra-53.

For Ubuntu 18.04 you may have to use the following advice <https://askubuntu.com/a/1070698/89097>_ if installing libav-tools doesn't work and you can't find avconv.

Setup database

1. For simplicity, switch to user postgres:

.. code-block:: console

sudo su - postgres

2. Install PostGIS in template1 (required for running tests):

.. code-block:: console

psql -d template1 -c 'create extension hstore;'

3. Log in to the database:

.. code-block:: console

psql

4. Create the user (replace django with your user):

.. code-block:: console

postgres=# CREATE USER django WITH PASSWORD 'django123';

5. Make created user a superuser on your database (this is required for tests only and shouldn't be done in production):

.. code-block:: console

postgres=# ALTER ROLE django WITH superuser;

6. Create the database (replace django with your user and geokey with a desired name for the database):

.. code-block:: console

postgres=# CREATE DATABASE geokey OWNER django;

7. Log out and connect to the database:

.. code-block:: console

postgres=# \q
psql -d geokey

8. Install the required extensions:

.. code-block:: console

geokey=# CREATE EXTENSION postgis;
geokey=# CREATE EXTENSION hstore;

9. Log out of the database and a user:

.. code-block:: console

geokey=# \q
logout

Setup GeoKey

1. Clone the repository:

.. code-block:: console

git clone https://github.com/ExCiteS/geokey.git

2. Install the package and development requirements:

.. code-block:: console

cd geokey
pip install -e .
pip install -r requirements.txt
pip install -r requirements-dev.txt

You may need to add sudo before the pip commands, unless you are logged in as root or working within a virtual environment.

3. Copy the directory local_settings.example to local_settings

.. code-block:: console

cp -r local_settings.example local_settings

4. Inside the local_settings open settings.py in a text editor and...

Add your database settings <https://docs.djangoproject.com/en/1.11/ref/settings/#databases>_:

.. code-block:: python

DATABASES = {
    'default': {
        'ENGINE': 'django.contrib.gis.db.backends.postgis',
        'NAME': 'geokey',
        'USER': 'django',
        'PASSWORD': 'xxxxxxxxx',
        'HOST': 'host',  # usually 'localhost'
        'PORT': ''
    }
}

Set the secret key <https://docs.djangoproject.com/en/1.11/ref/settings/#std:setting-SECRET_KEY>_:

.. code-block:: python

SECRET_KEY = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'

Set the STATIC_ROOT directory <https://docs.djangoproject.com/en/1.11/howto/static-files/#deployment>_:

.. code-block:: python

STATIC_ROOT = '/some/path/'

5. Migrate the database:

.. code-block:: console

python manage.py migrate

6. Add yourself as a superuser (you can use the same email and password to log into the system later):

.. code-block:: console

python manage.py createsuperuser

7. Run the collectstatic management command:

.. code-block:: console

python manage.py collectstatic

Run the test server

.. code-block:: console

python manage.py runserver 0.0.0.0:8000

Run tests

.. code-block:: console

python manage.py test

Running tests will remove all uploaded images of contributions from the assets directory. If you require to keep them, please use custom test settings with a --settings flag.

We use open-source technologies

GeoKey was built using some amazing open-source technology. We would like to thank all contributors to these projects:

• Django <https://www.djangoproject.com/>_
• django-rest-framework <http://www.django-rest-framework.org/>_
• django-rest-framework-gis <https://github.com/djangonauts/django-rest-framework-gis>_
• django-hstore <https://github.com/djangonauts/django-hstore>_
• django-braces <https://github.com/brack3t/django-braces>_
• django-pgjson <https://github.com/djangonauts/django-pgjson>_
• django-allauth <https://github.com/pennersr/django-allauth>_
• django-oauth-toolkit <https://github.com/evonove/django-oauth-toolkit>_
• django-model-utils <https://github.com/carljm/django-model-utils>_
• django-simple-history <https://github.com/treyhunner/django-simple-history>_
• django-aggregate-if <https://github.com/henriquebastos/django-aggregate-if>_
• django-youtube <https://github.com/laplacesdemon/django-youtube>_
• psycopg2 <http://initd.org/psycopg/>_
• iso8601 <https://bitbucket.org/micktwomey/pyiso8601>_
• pillow <http://python-pillow.github.io/>_
• django_nose <https://github.com/django-nose/django-nose>_
• pytz <http://pytz.sourceforge.net/>_
• gdata <https://code.google.com/p/gdata-python-client/>_
• easy-thumbnails <https://github.com/SmileyChris/easy-thumbnails>_
• moment <https://github.com/zachwill/moment>_
• requests <http://docs.python-requests.org/en/latest/>_
• factory-boy <http://factoryboy.readthedocs.org/en/latest/>_
• Handlebars <http://handlebarsjs.com>_
• Modernizr <https://modernizr.com>_
• Leaflet <http://leafletjs.com/>_
• Leaflet.Draw <https://github.com/Leaflet/Leaflet.draw>_
• jQuery <http://jquery.com/>_
• Bootstrap <http://getbootstrap.com/>_
• bootstrap-colorpicker <https://mjolnic.com/bootstrap-colorpicker/>_
• bootstrap-datetimepicker <https://eonasdan.github.io/bootstrap-datetimepicker/>_
• bootstrap-fileinput <https://github.com/kartik-v/bootstrap-fileinput>_