大家好,这篇文章介绍如何编写一个简单的 Python 项目初始化脚本。它涵盖了从创建虚拟环境到生成 requirements.txt
的完整流程,非常适合分享给刚开始规范项目结构的同学。
在日常开发中,我们常常会重复这些动作:
- 创建项目目录
- 初始化 Git 仓库
- 创建虚拟环境
- 安装必要依赖
- 生成
requirements.txt
- 添加
.gitignore
如果每次都手动操作,不仅麻烦,还容易出错。不如一次写好一个初始化脚本,以后所有项目 5 秒拉起,环境就绪!
一、目标
我们希望通过运行一个脚本,完成以下操作:
- 自动创建项目目录和结构
- 初始化 Git 仓库
- 创建并激活虚拟环境
- 安装依赖(可选)
- 自动生成
requirements.txt
- 自动添加
.gitignore
二、准备工作
创建一个文件,例如叫 init_project.sh
(Linux / macOS),或者 init_project.bat
(Windows)。本篇以 Linux/macOS 为例。
三、完整脚本内容(init_project.sh)
#!/bin/bash
# 用法: ./init_project.sh my_project_name
PROJECT_NAME=$1
if [ -z "$PROJECT_NAME" ]; then
echo "❌ 请提供项目名称: ./init_project.sh my_project"
exit 1
fi
echo "🚀 正在初始化项目: $PROJECT_NAME"
# 1. 创建项目目录
mkdir $PROJECT_NAME
cd $PROJECT_NAME
# 2. 初始化 Git 仓库
git init
echo "# $PROJECT_NAME" > README.md
# 3. 创建虚拟环境
python3 -m venv venv
source venv/bin/activate
# 4. 创建主目录结构
mkdir src tests
# 5. 创建 .gitignore
cat <<EOL > .gitignore
venv/
__pycache__/
*.pyc
.DS_Store
EOL
# 6. 安装一个测试依赖(例如 requests,可按需修改)
pip install requests
# 7. 生成 requirements.txt
pip freeze > requirements.txt
# 8. 初始 Git 提交
git add .
git commit -m "Initial project setup"
echo "✅ 项目初始化完成!现在你可以开始开发啦 🚀"
四、使用方法
- 将上述内容保存为
init_project.sh
- 给予可执行权限:
chmod +x init_project.sh
- 运行脚本:
./init_project.sh awesome_app
然后你将拥有这样的目录结构:
awesome_app/
├── README.md
├── .gitignore
├── requirements.txt
├── venv/
├── src/
└── tests/
五、可以拓展什么?
你可以根据需要拓展脚本,例如:
- 自动创建
setup.py
或pyproject.toml
- 添加黑白名单依赖(dev / prod)
- 集成测试框架(如 pytest)
- 支持 Windows(编写
.bat
或使用 Python 统一跨平台)
六、结语
项目初始化这件事,如果能一键搞定,既节省时间,又提升专业度。这个简单的脚本就是一个起点。
你可以把它放进自己的工具库里,也可以和团队成员共享。记住,写代码是创造,提升效率也是艺术。