Pyproject.nix 开源项目教程

Pyproject.nix 开源项目教程

pyproject.nix A collection of Nix utilities to work with Python projects [maintainer=@adisbladis] 项目地址: https://gitcode.com/gh_mirrors/py/pyproject.nix

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

Pyproject.nix 项目是一个用于处理 Python 项目元数据的 Nix 实用工具集。以下是项目的目录结构及其简要介绍：

pyproject.nix/
├── .github/               # GitHub 工作流和配置文件
│   ├── workflows/
│   │   ├── build.yml
│   │   └── doc.yml
├── lib/                   # 项目核心库文件
├── npins/                 # Nix 包管理相关文件
├── templates/             # 模板文件
├── test/                  # 测试文件
├── .envrc._nix/           # 环境变量配置文件
├── .envrc.lix/            # 环境变量配置文件
├── .gitignore             # Git 忽略文件
├── .mergify.yml           # Mergify 配置文件
├── LICENSE                # 项目许可证文件
├── Procfile               # 项目进程文件
├── README.md              # 项目自述文件
├── default.nix            # 默认 Nix 配置文件
├── flake.lock             # Flake 锁定文件
├── flake.nix              # Flake 配置文件
├── pyproject.toml         # Python 项目配置文件
├── renovate.json          # Renovate 配置文件
└── treefmt.nix            # 目录格式化配置文件

• .github/: 包含了项目在 GitHub 上所需的工作流和配置文件。
• lib/: 包含了项目的核心库代码，实现了 Python 包的打包和分发等功能。
• npins/: 包含了与 Nix 包管理相关的文件。
• templates/: 包含了项目模板文件，用于生成标准化的 Python 项目结构。
• test/: 包含了项目的测试代码，用于验证库的功能。
• .envrc._nix/ 和 .envrc.lix/: 环境变量配置文件，用于设置项目运行时的环境变量。
• .gitignore: 定义了 Git 应该忽略的文件和目录。
• .mergify.yml: Mergify 配置文件，用于自动化处理 PR。
• LICENSE: 项目所使用的许可证文件，本项目采用 MIT 许可。
• Procfile: 项目进程文件，定义了项目运行时需要启动的进程。
• README.md: 项目的自述文件，介绍了项目的相关信息和使用方法。
• default.nix: 默认的 Nix 配置文件，用于构建项目。
• flake.lock 和 flake.nix: Flake 配置文件，用于管理依赖和构建项目。
• pyproject.toml: Python 项目配置文件，定义了项目的元数据和依赖。
• renovate.json: Renovate 配置文件，用于自动化更新依赖。
• treefmt.nix: 用于格式化项目目录结构的配置文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 default.nix 文件。这个文件定义了如何使用 Nix 构建系统来编译和运行项目。以下是一个简单的 default.nix 文件示例：

{ pkgs, ... }:

pkgs.mkDerivation {
  name = "pyproject-nix";
  buildInputs = with pkgs; [ python ];
  propagatedBuildInputs = with pkgs; [ pyproject ];
  src = ./.;
}

这段代码创建了一个 Nix 包，它依赖于 Python 和 pyproject 包，并且将当前目录作为源代码。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 文件进行。这是一个 Python 项目标准配置文件，用于定义项目的元数据和依赖。以下是一个 pyproject.toml 文件的示例：

[project]
name = "pyproject-nix"
version = "0.1.0"
description = "Nix tooling for Python projects & metadata"
authors = ["@adisbladis"]
urls = { homepage = "https://pyproject-nix.github.io/pyproject.nix/" }

[project.dependencies]
python = { version = ">=3.7" }

这个配置文件定义了项目的名称、版本、描述、作者和主页链接，以及项目依赖的 Python 版本。这些信息用于项目打包和分发时提供必要的信息。

pyproject.nix A collection of Nix utilities to work with Python projects [maintainer=@adisbladis] 项目地址: https://gitcode.com/gh_mirrors/py/pyproject.nix