.py | 让自己的代码可以被别人使用

💡 原文中文,约3400字,阅读约需8分钟。
📝

内容提要

本文介绍了如何让自己的代码可以被别人使用,包括项目文件结构、填写 pyproject.toml、setup.cfg或setup.py文件以及打包和上传等步骤。其中,常用的文件结构有src-layout和flat-layout,参数主要包括name、packages和package_dir等。最后,还介绍了静态安装和动态安装的方法。

🎯

关键要点

  • 本文介绍了如何让自己的代码可以被别人使用,包括项目文件结构、填写 pyproject.toml、setup.cfg 或 setup.py 文件以及打包和上传等步骤。

  • 常用的项目文件结构有 src-layout 和 flat-layout,src-layout 结构中包含一个 src 文件夹,flat-layout 结构则直接将源代码文件夹放在项目根目录。

  • 单文件项目是 flat-layout 的一种特殊情况,只有一个 Python 文件。

  • 填写 pyproject.toml、setup.cfg 或 setup.py 文件是必要的,至少需要一个文件出现在项目根目录。

  • 项目参数包括 name、packages 和 package_dir,name 是必填项,packages 通常使用 setuptools.find_packages() 自动发现。

  • 打包和上传步骤包括安装 build 工具、运行 build 命令生成 dist/ 文件夹,并将打包成果上传到 PyPI。

  • 静态安装是指从 PyPI 安装已上传的包,动态安装则是在开发过程中使用 pip install -e . 命令,实时反映代码修改。

➡️

继续阅读