PaDELPy 项目使用教程

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

PaDELPy 是一个用于分子描述符计算的 Python 包装器，它允许通过 Python 直接访问 PaDEL-Descriptor 命令行接口。以下是项目的目录结构及其介绍：

padelpy/
├── github/workflows/
│   └── padelpy.yml
├── tests/
│   └── test_padelpy.py
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
└── setup.py

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• tests/: 包含项目的测试文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• MANIFEST.in: 指定在打包时包含的文件。
• README.md: 项目的说明文档。
• pyproject.toml: 项目构建工具的配置文件。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

PaDELPy 项目的启动文件主要是 setup.py，它负责项目的安装和分发。以下是 setup.py 的基本内容：

from setuptools import setup, find_packages

setup(
    name='padelpy',
    version='0.1.4',
    packages=find_packages(),
    install_requires=[
        # 依赖项列表
    ],
    entry_points={
        'console_scripts': [
            'padelpy=padelpy.main:main',
        ],
    },
)

• name: 项目的名称。
• version: 项目的版本号。
• packages: 需要包含的 Python 包。
• install_requires: 项目依赖的其他 Python 包。
• entry_points: 定义命令行脚本。

3. 项目的配置文件介绍

PaDELPy 项目的配置文件主要是 pyproject.toml，它用于指定项目构建工具的配置。以下是 pyproject.toml 的基本内容：

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

[project]
name = "padelpy"
version = "0.1.4"
description = "A Python wrapper for PaDEL-Descriptor"
authors = [
    { name="Travis Kessler", email="[e-mail]" }
]
license = { file="LICENSE" }
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
    # 依赖项列表
]

• [build-system]: 指定构建系统的要求和后端。
• [project]: 包含项目的基本信息，如名称、版本、描述、作者、许可证等。
• requires-python: 指定项目支持的 Python 版本。
• dependencies: 项目依赖的其他 Python 包。

以上是 PaDELPy 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 PaDELPy 项目。