Skip to main content

A ReSTful web api backed by cloudbridge for interacting with cloud providers

Project description

latest version available on PyPI Travis Build Status Test Coverage Report

A reusable Django app that exposes a ReSTful Web API for interacting with CloudBridge providers. The structure of the API mirrors the organisation of CloudBridge’s API and allows for creating, retrieving and updating CloudBridge resources.


The full documentation is at


Install djcloudbridge:

pip install djcloudbridge

Add it to your INSTALLED_APPS:


Add djcloudbridge’s URL patterns:

from djcloudbridge import urls as djcloudbridge_urls

urlpatterns = [
    url(r'^', include(djcloudbridge_urls)),

And finally, the following settings are recommended in your

    'PAGE_SIZE': 50,
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',

    'USER_DETAILS_SERIALIZER': 'djcloudbridge.serializers.UserSerializer'


# **Make sure to change** the value for ``FERNET_KEYS`` variable
# because it is used to encrypt sensitive database fields.
    'new key for encrypting'

Running the API Locally

You can run a test server to browse the API endpoints locally. DJCloudBridge is based on Python 3.6 and although it may work on older Python versions, 3.6 is the only supported version. Use of virtualenv is also highly advised.

To get started, simply register the provider connection information under the relevant cloud model (e.g. AWS, Azure, GCE, OpenStack) in Django Admin. Then create a User Profile under the User Profile model. Finally, use the API browser at http://localhost:8000/clouds to view the cloud you registered and interact with cloud resources for that provider.

  1. Checkout djcloudbridge and create environment

$ mkdir djcloudbridge && cd djcloudbridge
$ virtualenv -p python3.6 venv --prompt "(djcloudbridge)" && source venv/bin/activate
$ git clone
$ cd djcloudbridge
$ pip install -r requirements.txt
$ python migrate
$ python createsuperuser
$ python runserver
  1. Visit to define your cloud connection settings.

  2. Visit to explore the API.


  • TODO

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox


Tools used in rendering this package:


0.1.0 (2017-10-04)

  • First release on PyPI.

0.2.0 (2017-11-15)

  • Updated AWS cloud model to reflect cloudbridge changes.

  • Minor bug fixes

0.3.0 (2017-12-17)

  • Moved azure resource group, storage account and vm_default_username to credentials

  • Changed status to beta

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

djcloudbridge-0.3.1.tar.gz (26.1 kB view hashes)

Uploaded source

Built Distribution

djcloudbridge-0.3.1-py2.py3-none-any.whl (30.0 kB view hashes)

Uploaded 3 6

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page