panjiajie
  • Joined on 2026-01-18

pi (0.1.7)

Published 2026-01-28 14:44:38 +08:00 by panjiajie

Installation

pip install --index-url  --extra-index-url https://pypi.org/simple pi

About this package

Python 初始化项目工具

pi

Python 初始化项目骨架工具

pi 是一个用于快速创建 Python 项目骨架的命令行工具,支持在新目录或当前目录生成虚拟环境、常用文件和基础配置。

特性

  • 一键创建项目目录(默认在新目录,使用 -c/--current-dir 可在当前目录执行)
  • 可选创建虚拟环境 venv 并生成 enter.bat(Windows 快速进入)
  • 可选创建 README.md.gitignorepyproject.toml(带模板)
  • ~/.piconfig 加载 dotenv 配置;如存在 pypi_token,会在 enter.bat 中写入 UV_PUBLISH_TOKEN

环境要求

  • Windows(推荐),已安装 Python 3.12+,并具备 py 启动器
  • 依赖:dotenv>=0.9.9

安装

pip install wfg2026-pi

快速开始

  • 在新目录创建完整骨架(虚拟环境 + 常用文件):
pi my_app vrgp
  • 在当前目录创建(PROJECT_NAME 仅用于记录,不创建目录):
pi any_name v -c

也可使用模块形式运行:

python -m wfg2026_pi.pi PROJECT_NAME [FLAGS] [-c]

参数说明

  • PROJECT_NAME:目标项目名;未使用 -c 时将创建同名目录并切换进入
  • FLAGS:由 v r g p 组成的字符串(每个最多一次)
    • v:创建虚拟环境 venv,并生成 enter.bat
    • r:创建 README.md
    • g:创建 .gitignore
    • p:创建 pyproject.toml(使用内置模板)
  • -c, --current-dir:在当前目录执行,不新建项目目录

生成内容

  • venv/enter.bat(Windows 激活脚本,自动注入 UV_PUBLISH_TOKEN
  • README.md
  • .gitignore
  • pyproject.toml(含示例依赖与 project.scripts 模板)

配置文件 ~/.piconfig

使用 dotenv 读取,可包含如下键:

pypi_token=your-token

当存在 pypi_token 时,enter.bat 将追加:

set UV_PUBLISH_TOKEN=%pypi_token%

常见问题

  • 目标目录已存在时会记录错误并退出
  • Windows 上创建虚拟环境依赖 py 启动器;若缺失请安装标准 Python 发行版
  • 已存在的文件不会覆盖,会记录警告

升级

pip install -U wfg2026-pi

Requirements

Requires Python: >=3.12
Details
PyPI
2026-01-28 14:44:38 +08:00
8
9.2 KiB
Assets (2)
Versions (4) View all
1.0.1 2026-02-01
1.0.0 2026-01-28
0.1.8 2026-01-28
0.1.7 2026-01-28