https://github.com/excites/geokey-sapelli
Extends GeoKey with support for Sapelli
https://github.com/excites/geokey-sapelli
django geokey geokey-extension sapelli
Last synced: 4 months ago
JSON representation
Extends GeoKey with support for Sapelli
- Host: GitHub
- URL: https://github.com/excites/geokey-sapelli
- Owner: ExCiteS
- License: mit
- Created: 2015-05-08T15:39:30.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-11-03T14:39:34.000Z (over 6 years ago)
- Last Synced: 2025-01-11T10:38:02.669Z (4 months ago)
- Topics: django, geokey, geokey-extension, sapelli
- Language: Python
- Homepage:
- Size: 8.24 MB
- Stars: 2
- Watchers: 16
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://img.shields.io/pypi/v/geokey-sapelli.svg
:alt: PyPI Package
:target: https://pypi.python.org/pypi/geokey-sapelli
.. image:: https://img.shields.io/travis/ExCiteS/geokey-sapelli/master.svg
:alt: Travis CI Build Status
:target: https://travis-ci.org/ExCiteS/geokey-sapelli
.. image:: https://coveralls.io/repos/ExCiteS/geokey-sapelli/badge.svg?branch=master&service=github
:alt: Coveralls Test Coverage
:target: https://coveralls.io/github/ExCiteS/geokey-sapelli?branch=master
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:
.. code-block:: console
pip install geokey-sapelli
Or from cloned repository:
.. code-block:: console
cd geokey-sapelli
pip install -e .
Add the package to installed apps:
.. code-block:: console
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:
.. code-block:: console
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`:
.. code-block:: console
SAPELLI_CLIENT_ID = 'YOUR_CLIENT_ID'
Migrate the models into the database:
.. code-block:: console
python manage.py migrate geokey_sapelli
You're now ready to go!
Update
------
Update the geokey-sapelli from PyPI:
.. code-block:: console
pip install -U geokey-sapelli
Migrate the new models into the database:
.. code-block:: console
python manage.py migrate geokey_sapelli
Test
----
Run tests:
.. code-block:: console
python manage.py test geokey_sapelli
Check code coverage:
.. code-block:: console
pip install coverage
coverage run --source=geokey_sapelli manage.py test geokey_sapelli
coverage report -m --omit=*/tests/*,*/migrations/*