使用Projen创建Python项目的Hello World指南

使用Projen创建Python项目的Hello World指南

projen A new generation of project generators 项目地址: https://gitcode.com/gh_mirrors/pr/projen

前言

Projen是一个强大的项目生成和管理工具，它可以帮助开发者快速初始化项目结构并维护项目配置。本文将详细介绍如何使用Projen创建一个基础的Python项目，涵盖从环境准备到项目打包发布的完整流程。

环境准备

在开始创建项目前，请确保：

1. 已安装合适版本的Python（建议3.7+）
2. 确认终端中使用的Python版本正确
   • 在bash/zsh等POSIX shell中运行which python
   • 在PowerShell中运行Get-Command python

创建基础项目

使用以下命令创建新的Python项目：

npx projen new python --name=my-project

这个命令会生成一个标准的Python项目结构：

├── my_project
│   ├── __init__.py
│   ├── __main__.py
│   └── example.py
└── tests
    ├── __init__.py
    └── test_example.py

项目配置文件解析

Projen会生成一个.projenrc.py文件，这是项目的核心配置文件：

from projen.python import PythonProject

project = PythonProject(
    author_email="Author email",
    author_name="Author name",
    module_name="your_python_project",
    name="project_name",
    version="0.1.0",
)

project.synth()

这个文件定义了项目的基本信息，包括：

• 作者信息
• 模块名称
• 项目名称
• 版本号

修改此文件后，运行npx projen命令即可重新生成项目结构。

环境与依赖管理

Projen提供了多种Python环境管理方案：

默认配置

默认使用pip+venv+setuptools组合：

• pip：依赖管理
• venv：虚拟环境管理
• setuptools：打包工具

可选配置

可以切换为其他工具组合：

project = PythonProject(
    ...
    pip=False,
    venv=False,
    setuptools=False,
    poetry=True  # 使用poetry管理所有方面
)

依赖管理详解

Projen支持两种依赖类型：

1. 运行时依赖(deps)
2. 开发依赖(dev_deps)

依赖声明方式

1. 在项目初始化时声明：

project = PythonProject(
    deps=[
        'Django@3.1.5',
        'aws-cdk.core',  # 隐式使用最新版本
    ],
    dev_deps=[
        'hypothesis@^6.0.3',
    ]
)

2. 通过API动态添加：

project.add_dev_dependency('hypothesis@^6.0.3')

依赖版本语法

Projen使用语义化版本控制，语法为：<模块名>[@版本要求]

例如：

• Django@3.1.5：精确版本
• hypothesis@^6.0.3：兼容版本（自动转换为>=6.0.3,<7.0.0）

测试支持

Projen默认集成pytest测试框架：

• 测试代码放在tests目录
• 运行测试：npx projen test
• 如需禁用pytest，设置pytest=False

项目打包与发布

Projen支持两种打包方式：

1. Setuptools：传统方式，使用setup.py
2. Poetry：现代方式，使用pyproject.toml

打包命令

• 生成分发包：npx projen package
  • 会生成源码包(sdist)和wheel包
• 发布到PyPI：npx projen upload

最佳实践建议

1. 对于新项目，推荐使用Poetry作为统一管理工具
2. 保持.projenrc.py文件版本控制
3. 在团队中统一Projen版本
4. 定期运行npx projen同步项目配置

总结

通过Projen，开发者可以快速初始化标准化的Python项目，避免了手动创建各种配置文件的繁琐工作。Projen的强大之处在于：

1. 统一的项目结构
2. 灵活的配置方式
3. 集成了现代Python开发的最佳实践
4. 可扩展的架构设计

希望本指南能帮助你快速上手使用Projen管理Python项目。随着项目规模增长，你会发现Projen在维护大型项目配置一致性方面的巨大价值。

projen A new generation of project generators 项目地址: https://gitcode.com/gh_mirrors/pr/projen