pyArango 项目教程

pyArango 项目教程

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

pyArango 项目的目录结构如下：

pyArango/
├── examples/
│   └── 示例代码
├── pyArango/
│   └── 核心代码
├── .gitignore
├── .travis.yml
├── CHANGELOG.rst
├── CONTRIBUTING.md
├── DESCRIPTION.rst
├── LICENSE
├── MANIFEST.in
├── README.rst
├── run_tests.sh
├── setup.cfg
└── setup.py

目录介绍

• examples/: 包含一些示例代码，帮助用户快速上手。
• pyArango/: 项目的核心代码目录。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.rst: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• DESCRIPTION.rst: 项目描述。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.rst: 项目自述文件。
• run_tests.sh: 测试脚本。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。

2. 项目的启动文件介绍

pyArango 项目的启动文件主要是 setup.py。这个文件负责项目的安装和分发。用户可以通过以下命令安装 pyArango：

pip install pyArango

或者从源码安装：

git clone https://github.com/ArangoDB-Community/pyArango.git
cd pyArango
python setup.py develop

3. 项目的配置文件介绍

pyArango 项目的配置文件主要是 setup.cfg。这个文件包含了安装和打包的配置信息。以下是 setup.cfg 的部分内容：

[metadata]
name = pyArango
version = attr: pyArango.__version__
description = A Python driver for ArangoDB with built-in validation
long_description = file: README.rst, CHANGELOG.rst
url = https://github.com/ArangoDB-Community/pyArango
author = Tariq Daouda
license = Apache Software License (ApacheV2)
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    Intended Audience :: System Administrators
    License :: OSI Approved :: Apache Software License
    Programming Language :: Python :: 2.7
    Programming Language :: Python :: 3
    Topic :: Database
    Topic :: Database :: Database Engines/Servers
    Topic :: Software Development

[options]
packages = find:
install_requires =
    requests
    six

[options.packages.find]
where = .

配置文件介绍

• [metadata]: 包含项目的元数据，如名称、版本、描述、作者等。
• [options]: 包含安装选项，如需要安装的包和依赖。
• [options.packages.find]: 指定查找包的位置。

通过这些配置文件，用户可以了解项目的安装和配置信息，从而更好地使用和开发 pyArango。