Integration with existing Django project

This document describes how to include zeus-ci into existing Django project. It assumes user knows how to manage Django project and is familiar with it’s basic concepts.

Note

Make sure you have zeus-ci Python package already installed:

$ pip install zeusci

Add zeus to INSTALLED_APPS

Include zeusci.zeus in INSTALLED_APPS at settings.py file:

INSTALLED_APPS = (
    # other apps
    'zeusci.zeus',
)

Configure celery

zeus-ci uses Celery. Refer to it’s documentation on how to configure message broker and integrate Celery with Django project.

Add url routes

We need to hook zeusci endpoints (including API) at our urls.py. This can be done as follows:

from django.conf.urls import patterns, url, include
from zeusci import zeus


urlpatterns = patterns('',
    # other url patterns
    url(r'^', include(zeus.site.urls)),
)

You can also include API and UI endpoints separately:

urlpatterns = patterns('',
    # other url patterns
    url(r'^', include(zeus.site.api_urls)),
    url(r'^', include(zeus.site.ui_urls)),
)