PyScaffold 使用教程

PyScaffold 使用教程

pyscaffold 🛠 Python project template generator with batteries included 项目地址: https://gitcode.com/gh_mirrors/py/pyscaffold

1. 项目介绍

PyScaffold 是一个用于引导创建高质量的 Python 包的开源项目生成器。它旨在帮助开发者快速搭建可在 PyPI 上共享和通过 pip 安装的包。PyScaffold 采用了一系列最佳实践和工具，使得项目维护和开发更加高效、愉快。

2. 项目快速启动

首先，您需要安装 PyScaffold。有多种方式可以安装：

# 使用 pip 安装
pip install pyscaffold

# 使用 conda 安装（推荐给数据科学用户）
conda install -c conda-forge pyscaffold

# 使用 pipx 安装（适合 virtualenv 用户）
pipx install pyscaffold

安装完毕后，您将得到一个新的命令 putup。使用这个命令可以创建一个新的项目文件夹：

putup my_project

上述命令将在当前目录下创建一个名为 my_project 的新文件夹，其中包含了一个完整的项目模板。接下来，进入项目文件夹，并创建一个隔离的开发环境（使用 virtualenv、conda 或您偏好的工具）：

cd my_project
# 创建或激活隔离环境
# 示例使用 virtualenv
python -m venv venv
source venv/bin/activate  # 在 Windows 下使用 venv\Scripts\activate

在激活的环境中，执行以下命令进行编辑安装：

pip install -e .

现在，您的项目已经准备好开发工作了。

3. 应用案例和最佳实践

PyScaffold 生成的项目模板已经包含了许多最佳实践，以下是一些应用案例：

• 配置和打包：使用 setup.cfg 管理项目配置，大多数情况下无需修改 setup.py。

• 构建和发布：使用 tox 进行自动化任务，如构建项目包：

  tox -e build
  

  发布前进行测试：

  tox -e publish -- --repository pypi
  

• 版本和 Git 集成：项目已经初始化为 Git 仓库，使用 setuptools_scm 根据 Git 标签自动推断版本。

• 预提交钩子：使用预提交钩子确保代码风格和测试通过。

4. 典型生态项目

PyScaffold 支持的项目类型通常包括但不限于以下几种：

• 标准库项目：适用于构建标准 Python 库。
• 数据科学项目：集成了数据科学所需的工具和依赖。
• Web 应用项目：为构建 Web 应用提供了基础结构和框架支持。

通过以上介绍，您可以开始使用 PyScaffold 来创建和管理您的 Python 项目。遵循其最佳实践，可以让您的项目保持结构化和易于维护。

pyscaffold 🛠 Python project template generator with batteries included 项目地址: https://gitcode.com/gh_mirrors/py/pyscaffold