Welcome to the Django WMS code base!

Django WMS Client is a django application for providing a gallery of wms maps. We provide the following functionality:

Automated service metadata retrieval (via owslib ).
Gallery of available services (with thumbnail and description of each registered service).
Map view which generates a simple leaflet browser for a WMS endpoint.

Please note that this project is in the early phase of its development.

You can visit a running instance of this project at http://wms_client_demo.kartoza.com.

Status

These badges reflect the current status of our development branch:

Tests status:

Coverage status:

Development status:

License

Code: Free BSD License

Out intention is to foster wide spread usage of the data and the code that we provide. Please use this code and data in the interests of humanity and not for nefarious purposes.

Purpose

This django app allows you to easily publish your QGIS Server (or any WMS based) projects within django - its available at:

https://github.com/kartoza/django-wms-client

Its usable both as a simple standalone project (mainly for testing purposes) or as a django app that you can embed into any other django project (e.g. your mezzanine CMS). A complete docker environment is provided which you can use to test and deploy under the same architecture.

Django admin

A django admin page is the basic mechanism used for registering new resources:

You can define a number of properties about each resource, though at minimum only the name and URI are required. The rest will be autopopulated by parsing a WMS getCapabilitiesRequest for the service. Just make sure to:

Populate the abstract for your service offering
Ensure that your service offering provides spherical mercator (EPSG:3857)

Using this approach you can populate as many services (WMS Resources) as you like:

The index view

On the front end, we provide two views. The index view provides a gallery of all the maps you have registered:

The map view

The map view provides a leaflet full screen map that presents the given WMS Resource.

Setup instructions

Simple deployment under docker

Overview

You need two docker containers:

A postgis container
A uwsgi container

We assume you are running nginx on the host and we will set up a reverse proxy to pass django requests into the uwsgi container. Static files will be served directly using nginx on the host.

A convenience script is provided under scripts\create_docker_env.sh which should get everything set up for you. Note you need at least docker 1.2 - use the installation notes on the official docker page to get it set up.

Check out the source

First checkout out the source tree:

git clone git://github.com/kartoza/django_wms_client.git

Build your docker images and run them

You can simply run the provided script and it will build and deploy the docker images for you. Note if you are using apt-cacher-ng (we recommend it as it will dramatically speed up build times), be sure to edit docker-prod/71-apt-cacher-ng and comment out existing lines, adding your own server. Alternatively if you wish to fetch packages are downloaded directly from the internet, ensure that all lines are commented out in your hosts

docker-prod/71-apt-cacher-ng
docker-dev/71-apt-cacher-ng

cd wms_client-django
scripts\create_docker_env.sh

Setup nginx reverse proxy

You should create a new nginx virtual host - please see wms_client-nginx.conf in the root directory of the source for an example.

For local development

Install dependencies

virtualenv venv
source venv/bin/activate
pip install -r docker-prod/REQUIREMENTS.txt
pip install -r docker-dev/REQUIREMENTS-dev.txt
nodeenv -p --node=0.10.31
npm -g install yuglify

Create your dev profile

cd django_project/core/settings
cp dev_timlinux.py dev_${USER}.py

Now edit dev_<your username> setting your database connection details as needed. We assume you have created a postgres (with postgis extentions) database somewhere that you can use for your development work. See http://postgis.net/install/ for details on doing that.

Running migrate, collect static, and development server

Prepare your database and static resources by doing this:

virtualenv venv
source venv/bin/activate
cd django_project
python manage.py migrate --settings=core.settings.dev_${USER}
python manage.py collectstatic --noinput --settings=core.settings.dev_${USER}
python manage.py runserver --settings=core.settings.dev_${USER}

Note: You can also develop in docker using the instructions provided in README-dev.md.

dimasciput/django-wms-client