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.

Documentation

The full documentation is at https://djcloudbridge.readthedocs.io.

Quickstart

Install djcloudbridge:

pip install djcloudbridge

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'djcloudbridge.apps.DjangoCloudbridgeConfig',
    ...
)

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 settings.py

REST_FRAMEWORK = {
    'PAGE_SIZE': 50,
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'DEFAULT_AUTHENTICATION_CLASSES': (
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.TokenAuthentication'
    )
}

REST_AUTH_SERIALIZERS = {
    'USER_DETAILS_SERIALIZER': 'djcloudbridge.serializers.UserSerializer'
}

REST_SESSION_LOGIN = True

# **Make sure to change** the value for ``FERNET_KEYS`` variable
# because it is used to encrypt sensitive database fields.
FERNET_KEYS = [
    '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 https://github.com/cloudve/djcloudbridge.git
$ cd djcloudbridge
$ pip install -r requirements.txt
$ cd djcloudbridge
$ python manage.py migrate
$ python manage.py runserver
$ python manage.py createsuperuser
  1. Visit http://127.0.0.1:8000/admin/ to define your cloud connection settings.

  2. Visit http://127.0.0.1:8000/clouds/ to explore the API.

Features

  • TODO

Running Tests

Does the code actually work?

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

Credits

Tools used in rendering this package:

History

0.1.0 (2017-10-04)

  • First release on PyPI.

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.1.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

djcloudbridge-0.1.0-py2.py3-none-any.whl (28.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file djcloudbridge-0.1.0.tar.gz.

File metadata

  • Download URL: djcloudbridge-0.1.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for djcloudbridge-0.1.0.tar.gz
Algorithm Hash digest
SHA256 80c837e5d3311dfd0d68ebe44d83fcee83c2bc85f746b7df10c7f5f2975ea9fe
MD5 38469d7cf0cb063d53b08593cd5cb2f7
BLAKE2b-256 b45c2af31e93bc1befa16a78cd31b269aaa6fbf54dbcf025e5c7e98dbdb8cb11

See more details on using hashes here.

File details

Details for the file djcloudbridge-0.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for djcloudbridge-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1bec3e9160d59edc9baa95ec4e9f52d23f8e0e7a9bf169330e2e6568bb1b17a0
MD5 56d945a20f42f98935433e9bb04351b5
BLAKE2b-256 65807ec16565f4477fc41751d8707f3c2985416cbe3dc268ed9c93aedd486e6e

See more details on using hashes here.

Supported by

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