### 创建 Python 项目并打包为可安装模块的步骤 #### 1. 项目结构设计 创建一个 Python 项目时，首先需要设计合理的目录结构，以便后续打包和分发。一个标准的 Python 项目通常包括以下内容： - 项目根目录 - 一个或多个模块（Python 包） - `setup.py` 文件（用于打包） - `README.md`（项目说明） - `requirements.txt`（依赖库列表） - `LICENSE`（许可证文件） 一个典型的项目结构如下： ``` your_project/ │ ├── your_project/ │ ├── __init__.py │ └── module.py │ ├── tests/ │ └── test_module.py │ ├── setup.py ├── README.md ├── requirements.txt └── LICENSE ``` #### 2. 编写 `setup.py` `setup.py` 是打包的核心文件，用于定义项目元数据和打包配置。以下是一个基本示例： ```python from setuptools import setup, find_packages setup( name="your_project", version="0.1", packages=find_packages(), install_requires=[ # 项目依赖库 ], entry_points={ 'console_scripts': [ 'your-command=your_project.module:main', ], }, author="Your Name", author_email="your.email@example.com", description="A short description of the project", long_description=open("README.md").read(), long_description_content_type="text/markdown", url="https://github.com/your-username/your-project", classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], python_requires='>=3.6', ) ``` 此文件定义了项目的名称、版本、依赖项、入口脚本等信息，是构建可安装模块的关键[^1]。 #### 3. 构建分发包 在项目根目录下运行以下命令，生成可分发的包： ```bash python setup.py sdist bdist_wheel ``` 这将生成两个文件： - `dist/your_project-0.1.tar.gz`（源码包） - `dist/your_project-0.1-py3-none-any.whl`（wheel 包） 这些文件可以上传到 PyPI 或直接提供给他人安装使用。 #### 4. 安装与测试 他人可以通过以下命令安装你的模块： ```bash pip install your_project-0.1.tar.gz ``` 或安装 wheel 包： ```bash pip install your_project-0.1-py3-none-any.whl ``` 安装完成后，他们可以导入模块或运行通过 `entry_points` 定义的命令行工具。 #### 5. 上传到 PyPI 如果你想将模块发布到 Python 官方包仓库 PyPI，可以使用 `twine` 工具： ```bash pip install twine twine upload dist/* ``` 这将提示你输入 PyPI 的用户名和密码，上传后其他人就可以通过 `pip install your_project` 来安装你的模块[^1]。 #### 6. 使用虚拟环境进行开发与测试 为了确保打包过程的干净与可重复性，建议在虚拟环境中进行开发和测试。可以通过以下方式创建虚拟环境： ```bash python -m venv venv source venv/bin/activate # Linux/macOS venv\Scripts\activate # Windows ``` 然后安装开发依赖： ```bash pip install -e . ``` 这样可以在不打包虚拟环境的情况下测试模块功能，确保模块在不同环境中正常运行[^2]。 #### 7. 使用 `requirements.txt` 管理依赖 在项目根目录下创建 `requirements.txt` 文件，列出所有依赖库： ``` requests>=2.25.1 numpy>=1.21.0 ``` 他人在安装模块前可以运行： ```bash pip install -r requirements.txt ``` 以确保所有依赖项正确安装[^2]。 #### 8. 提供文档与许可证 在 `README.md` 中提供项目说明、安装步骤、使用示例等信息。同时选择合适的开源许可证（如 MIT、Apache 等），并将其内容写入 `LICENSE` 文件，以确保代码使用的合法性[^1]。 --- ###