Skip to content

Extends GeoKey with support for Sapelli

License

Notifications You must be signed in to change notification settings

ExCiteS/geokey-sapelli

Repository files navigation

PyPI Package Travis CI Build Status Coveralls Test Coverage

geokey-sapelli

Extension for GeoKey to add support for Sapelli. This extension enables users to upload Sapelli project files (resulting in corresponding GeoKey projects), and Sapelli-produced data via the admin interface.

Install

geokey-sapelli requires:

  • Python version 2.7
  • Java (JRE or JDK) version 7 or up
  • GeoKey version 1.6 or greater

Install the geokey-sapelli from PyPI:

pip install geokey-sapelli

Or from cloned repository:

cd geokey-sapelli
pip install -e .

Add the package to installed apps:

INSTALLED_APPS += (
    ...
    'geokey_sapelli',
)

Download the latest available version of the Sapelli Collector CmdLn front-end (the file you need looks like sapelli-collector-cmdln-X.X.X-XXXXXX-with-dependencies.jar). Place the file in a folder of your choice (you can rename it as well if you want) and edit the settings.py file to add the absolute path to the file:

SAPELLI_JAR = '/path/to/sapelli-collector-cmdln-X.X.X-XXXXXX-with-dependencies.jar'

Register a new application (using the GeoKey admin interface) with authorisation type password. Add the generated Client ID to your settings.py:

SAPELLI_CLIENT_ID = 'YOUR_CLIENT_ID'

Migrate the models into the database:

python manage.py migrate geokey_sapelli

You're now ready to go!

Update

Update the geokey-sapelli from PyPI:

pip install -U geokey-sapelli

Migrate the new models into the database:

python manage.py migrate geokey_sapelli

Test

Run tests:

python manage.py test geokey_sapelli

Check code coverage:

pip install coverage
coverage run --source=geokey_sapelli manage.py test geokey_sapelli
coverage report -m --omit=*/tests/*,*/migrations/*