OdooRPC 项目使用文档

OdooRPC 项目使用文档

odoorpcPython module to pilot your Odoo servers through JSON-RPC.项目地址:https://gitcode.com/gh_mirrors/od/odoorpc

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

OdooRPC 项目的目录结构如下：

odoorpc/
├── doc/
│   └── odoorpc/
├── odoorpc/
│   ├── __init__.py
│   ├── tools.py
│   └── error.py
├── sphinx_ext/
├── flake8
├── .gitignore
├── .isort.cfg
├── .pre-commit-config.yaml
├── .travis.yml
├── AUTHORS
├── CHANGELOG
├── LICENSE
├── MANIFEST.in
├── README.rst
├── bump_version.sh
├── pyproject.toml
├── run_tests_docker.sh
├── setup.cfg
└── setup.py

目录结构介绍

• doc/: 包含项目的文档文件。
• odoorpc/: 核心代码目录，包含项目的初始化文件、工具文件和错误处理文件。
• sphinx_ext/: Sphinx 文档生成工具的扩展。
• flake8: Flake8 代码风格检查工具的配置文件。
• .gitignore: Git 版本控制忽略文件配置。
• .isort.cfg: isort 代码排序工具的配置文件。
• .pre-commit-config.yaml: pre-commit 钩子配置文件。
• .travis.yml: Travis CI 持续集成配置文件。
• AUTHORS: 项目作者列表。
• CHANGELOG: 项目更新日志。
• LICENSE: 项目许可证文件。
• MANIFEST.in: 打包清单文件。
• README.rst: 项目介绍和使用说明。
• bump_version.sh: 版本号更新脚本。
• pyproject.toml: 项目构建工具配置文件。
• run_tests_docker.sh: 使用 Docker 运行测试的脚本。
• setup.cfg: 安装配置文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

OdooRPC 项目的启动文件是 setup.py。这个文件用于安装和管理项目的依赖，以及打包和分发项目。

setup.py 文件内容概述

from setuptools import setup, find_packages

setup(
    name='odoorpc',
    version='0.6.2',
    description='OdooRPC is a Python package providing an easy way to pilot your Odoo servers through RPC',
    long_description=open('README.rst').read(),
    author='Sébastien Alix',
    author_email='sebastien.alix@osiell.com',
    url='https://github.com/OCA/odoorpc',
    license='LGPL v3',
    packages=find_packages(),
    install_requires=[],
    classifiers=[
        'Development Status :: 5 - Production/Stable',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
    ],
)

启动文件功能

• 定义项目名称、版本、描述、作者和许可证信息。
• 读取 README.rst 文件作为长描述。
• 使用 find_packages() 自动查找并包含所有包。
• 定义安装依赖。
• 设置项目的分类器，包括开发状态、目标受众、许可证类型和编程语言版本。

3. 项目的配置文件介绍

OdooRPC 项目的配置文件主要包括 setup.cfg 和 .travis.yml。

setup.cfg 文件内容概述

[flake8]
max-line-length = 80
ignore = E203, E266, E501, W503

[isort]
line_length = 80
multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True

[tool:pytest]
addopts = --cov=odoor

odoorpcPython module to pilot your Odoo servers through JSON-RPC.项目地址:https://gitcode.com/gh_mirrors/od/odoorpc