跳至内容

init

此命令使用 Rye 初始化一个新的或现有的 Python 项目。 在包含现有 Python 项目的文件夹中运行它将尝试将其转换并立即引导 Rye。 否则，它可用于从头开始创建一个全新的项目。

有关更多信息，请参见基础指南。

示例

$ rye init
success: Initialized project in /Users/john/Development/my-project.
  Run `rye sync` to get started

参数

  • [PATH]: 项目放置位置（默认为当前路径）

选项

  • --min-py <MIN_PY>: 此项目支持的最小 Python 版本

  • -p, --py <PY>: 用于虚拟环境的 Python 版本

  • --no-readme: 不创建自述文件

  • --no-pin: 不创建 .python-version 文件（将使用 requires-python）

  • --build-system <BUILD_SYSTEM>: 应使用哪个构建系统（默认为 hatchling）？

    [可能的取值: hatchling, setuptools, flit, pdm, maturin]

  • --license <LICENSE>: 应使用哪个许可证？SPDX 标识符

  • --name <NAME>: 包的名称

  • --private: 设置“Private :: Do Not Upload”分类器，用于私有项目

  • --no-import: 不要从 setup.cfg、setup.py 或要求文件中导入

  • --virtual: 将其初始化为虚拟包。

    虚拟包可以有依赖项，但本身不作为 Python 包安装。 它也不能发布。

  • -r, --requirements <REQUIREMENTS_FILE>: 用于初始化 pyproject.toml 的要求文件

  • --dev-requirements <DEV_REQUIREMENTS_FILE>: 用于初始化 pyproject.toml 的开发要求文件

  • -v, --verbose: 启用详细诊断

  • -q, --quiet: 关闭所有输出

  • -h, --help: 打印帮助（使用“-h”查看摘要）