Python-oracledb 项目教程

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

python-oracledb/
├── CONTRIBUTING.md
├── LICENSE.txt
├── MANIFEST.in
├── NOTICE.txt
├── README.md
├── README.txt
├── SECURITY.md
├── THIRD_PARTY_LICENSES.txt
├── pyproject.toml
├── setup.cfg
├── setup.py
├── tox.ini
├── doc/
├── samples/
├── src/
│   └── oracledb/
├── tests/
└── utils/

目录结构介绍

• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
• LICENSE.txt: 项目的开源许可证文件。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• NOTICE.txt: 项目通知文件，包含版权声明等信息。
• README.md: 项目的主文档，包含项目的基本介绍、安装和使用说明。
• README.txt: 项目的文本格式介绍文件。
• SECURITY.md: 安全指南，包含项目的安全漏洞披露流程。
• THIRD_PARTY_LICENSES.txt: 第三方许可证文件，列出项目所依赖的第三方库的许可证。
• pyproject.toml: 项目配置文件，用于定义项目的构建系统和其他元数据。
• setup.cfg: 项目的配置文件，用于定义安装和打包的配置。
• setup.py: 项目的安装脚本，用于安装项目及其依赖。
• tox.ini: 用于定义项目的测试配置。
• doc/: 项目的文档目录，包含详细的文档和教程。
• samples/: 项目的示例代码目录，包含使用项目的示例代码。
• src/oracledb/: 项目的源代码目录，包含Python驱动程序的核心代码。
• tests/: 项目的测试代码目录，包含项目的单元测试和集成测试。
• utils/: 项目的工具目录，包含项目使用的各种工具和脚本。

2. 项目的启动文件介绍

项目的启动文件主要是 setup.py，它是一个标准的Python安装脚本，用于安装项目及其依赖。通过运行以下命令可以安装项目：

python setup.py install

此外，项目的启动还可以通过 python -m pip install oracledb 命令来完成，这是推荐的安装方式。

3. 项目的配置文件介绍

setup.cfg

setup.cfg 是项目的配置文件，用于定义安装和打包的配置。以下是 setup.cfg 的部分内容示例：

[metadata]
name = oracledb
version = 2.4.1
description = Python driver for Oracle Database conforming to the Python DB API 2.0 specification
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/oracle/python-oracledb
author = Oracle
license = Apache License 2.0

pyproject.toml

pyproject.toml 是项目的配置文件，用于定义项目的构建系统和其他元数据。以下是 pyproject.toml 的部分内容示例：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

tox.ini

tox.ini 是项目的测试配置文件，用于定义项目的测试环境和测试命令。以下是 tox.ini 的部分内容示例：

[tox]
envlist = py38, py39, py310

[testenv]
deps =
    pytest
commands =
    pytest tests/

通过这些配置文件，开发者可以方便地管理和配置项目的安装、打包和测试过程。