OpenStack SDK 项目教程

OpenStack SDK 项目教程

openstacksdkUnified SDK for OpenStack. Mirror of code maintained at opendev.org.项目地址:https://gitcode.com/gh_mirrors/op/openstacksdk

项目的目录结构及介绍

OpenStack SDK 项目的目录结构如下：

openstacksdk/
├── doc/
│   ├── source/
│   │   ├── conf.py
│   │   └── index.rst
├── openstacksdk/
│   ├── __init__.py
│   ├── _meta.py
│   ├── auth/
│   ├── cloud/
│   ├── config/
│   ├── connection.py
│   ├── exceptions.py
│   ├── hacking/
│   ├── limit.py
│   ├── proxy.py
│   ├── provider_config.py
│   └── utils.py
├── README.rst
├── setup.cfg
├── setup.py
├── test-requirements.txt
├── tox.ini
└── requirements.txt

目录结构介绍

• doc/: 包含项目的文档源文件。
  • source/: 文档的源文件目录。
    • conf.py: Sphinx 文档配置文件。
    • index.rst: 文档的主索引文件。
• openstacksdk/: 项目的主要代码目录。
  • __init__.py: 模块初始化文件。
  • _meta.py: 元数据文件。
  • auth/: 认证相关模块。
  • cloud/: 云服务相关模块。
  • config/: 配置相关模块。
  • connection.py: 连接管理模块。
  • exceptions.py: 异常处理模块。
  • hacking/: 代码风格检查工具。
  • limit.py: 限制管理模块。
  • proxy.py: 代理管理模块。
  • provider_config.py: 提供者配置模块。
  • utils.py: 工具函数模块。
• README.rst: 项目说明文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• test-requirements.txt: 测试依赖文件。
• tox.ini: 自动化测试配置文件。
• requirements.txt: 项目依赖文件。

项目的启动文件介绍

OpenStack SDK 项目的启动文件主要是 setup.py。这个文件用于安装和管理项目的依赖，并提供了一些基本的命令行接口。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name="openstacksdk",
    version="0.101.0",
    packages=find_packages(exclude=["test*"]),
    install_requires=[
        "pbr>=2.0.0",
        "iso8601>=0.1.11",
        "stevedore>=1.20.0",
        "os-service-types>=1.2.0",
        "keystoneauth1>=3.4.0",
        "requests>=2.14.2",
        "decorator>=3.4.0",
        "deprecation>=2.0.6",
        "requestsexceptions>=1.2.0",
        "jsonpatch>=1.16",
        "appdirs>=1.4.3",
        "yaml>=3.12",
        "dogpile.cache>=0.6.5",
        "jmespath>=0.9.0",
    ],
    entry_points={
        "openstack.cloud": [
            "openstack = openstacksdk.cloud:OpenStackCloud"
        ],
    },
)

主要功能

• 定义项目名称和版本。
• 指定需要安装的包和依赖。
• 配置入口点，定义项目的入口类。

项目的配置文件介绍

OpenStack SDK 项目的配置文件主要是 setup.cfg 和 tox.ini。

setup.cfg 文件介绍

[metadata]
name = openstacksdk
version = 0.101.0
description = A client library for building applications to work with OpenStack clouds
author = OpenStack
author_email = openstack-discuss@lists.openstack.org
url = https://docs.openstack.org/openstacksdk/latest/
license = Apache License, Version 2.0

[options]
packages = find:
install

openstacksdkUnified SDK for OpenStack. Mirror of code maintained at opendev.org.项目地址:https://gitcode.com/gh_mirrors/op/openstacksdk