Proxmoxer 项目教程

Proxmoxer 项目教程

1. 项目的目录结构及介绍

Proxmoxer 是一个 Python 包装器，用于 Proxmox REST API。以下是项目的目录结构及其介绍：

proxmoxer/
├── devcontainer/
├── github/workflows/
├── vscode/
├── proxmoxer/
│   ├── __init__.py
│   ├── base.py
│   ├── proxmox.py
│   ├── pvesh.py
│   ├── ssh.py
│   └── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_proxmoxer.py
│   └── test_utils.py
├── bandit
├── git-blame-ignore-revs
├── gitignore
├── pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE.txt
├── MANIFEST.in
├── README.rst
├── dev_requirements.txt
├── pyproject.toml
├── setup.cfg
├── setup.py
└── test_requirements.txt

目录结构介绍

• devcontainer/: 包含开发容器配置文件。
• github/workflows/: 包含 GitHub Actions 工作流配置文件。
• vscode/: 包含 Visual Studio Code 配置文件。
• proxmoxer/: 核心代码目录，包含项目的主要实现文件。
  • __init__.py: 模块初始化文件。
  • base.py: 基础类和函数。
  • proxmox.py: Proxmox API 的主要实现。
  • pvesh.py: Proxmox Shell 工具的实现。
  • ssh.py: SSH 后端的实现。
  • utils.py: 工具函数。
• tests/: 测试代码目录，包含项目的测试文件。
  • __init__.py: 测试模块初始化文件。
  • test_proxmoxer.py: Proxmoxer 的测试文件。
  • test_utils.py: 工具函数的测试文件。
• bandit: 安全审计工具配置文件。
• git-blame-ignore-revs: Git 忽略修订配置文件。
• gitignore: Git 忽略文件配置。
• pre-commit-config.yaml: 预提交钩子配置文件。
• CHANGELOG.md: 变更日志。
• LICENSE.txt: 许可证文件。
• MANIFEST.in: 清单文件。
• README.rst: 项目说明文档。
• dev_requirements.txt: 开发依赖文件。
• pyproject.toml: 项目配置文件。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• test_requirements.txt: 测试依赖文件。

2. 项目的启动文件介绍

Proxmoxer 项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖项，并提供了一些命令行工具来管理项目。

setup.py 文件介绍

from setuptools import setup, find_packages

setup(
    name='proxmoxer',
    version='1.2.0',
    packages=find_packages(),
    install_requires=[
        'requests',
    ],
    extras_require={
        'ssh': ['paramiko'],
    },
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: MIT License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
    url='https://github.com/swayf/proxmoxer',
    author='Fabian Peter Hammerle',
    author_email='fabian@hammerle.me',
    license='MIT',
    keywords='proxmox api wrapper',
    description='Python wrapper for Proxmox API v2',
    long_description=open('README.rst').read(),
    long_description_content_type='text/x-rst',
)

主要功能

• 定义项目名称、版本