跳转到主要内容

基于cloudbridge的云服务提供商交互的RESTful Web API

项目描述

latest version available on PyPI Travis Build Status Test Coverage Report

一个可重复使用的Django应用,它公开了一个RESTful Web API,用于与CloudBridge提供者交互。API的结构反映了CloudBridge API的组织结构,并允许创建、检索和更新CloudBridge资源。

文档

完整文档位于https://djcloudbridge.readthedocs.io

快速入门

安装djcloudbridge

pip install djcloudbridge

将其添加到您的INSTALLED_APPS

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

添加djcloudbridge的URL模式

from djcloudbridge import urls as djcloudbridge_urls


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

最后,在您的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'
]

本地运行API

您可以在本地运行测试服务器以浏览API端点。DJCloudBridge基于Python 3.6,尽管它可能在较旧的Python版本上运行,但3.6是唯一支持的版本。使用virtualenv也非常建议。

要开始,只需在Django Admin中注册相关云模型(例如AWS、Azure、GCE、OpenStack)下的提供者连接信息。然后,在用户配置文件模型下创建用户配置文件。最后,使用http://localhost:8000/clouds上的API浏览器查看已注册的云并交互云资源。

  1. 检出djcloudbridge并创建环境

$ 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
$ python manage.py migrate
$ python manage.py createsuperuser
$ python manage.py runserver
  1. 访问 http://127.0.0.1:8000/admin/ 以定义您的云连接设置。

  2. 访问 http://127.0.0.1:8000/clouds/ 以探索API。

功能

  • 待办事项

运行测试

代码真的工作吗?

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

鸣谢

用于渲染此包的工具

历史

0.1.0 (2017-10-04)

  • 首次发布于PyPI。

0.2.0 (2017-11-15)

  • 更新AWS云模型以反映cloudbridge更改。

  • 小错误修复

0.3.0 (2017-12-17)

  • 将azure资源组、存储帐户和vm_default_username移动到凭证

  • 更改为beta版本

项目详情


下载文件

下载适合您平台文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源分布

djcloudbridge-0.3.1.tar.gz (26.1 kB 查看散列)

上传时间

构建分布

djcloudbridge-0.3.1-py2.py3-none-any.whl (30.0 kB 查看散列)

上传时间 Python 2 Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面