饮冰十年-人工智能-Python项目打包

  打包是将你的Python项目组织成可分发的形式,使其他人能够轻松地安装、使用和维护你的代码。这对于代码分享、开源项目、团队协作以及将你的工作发布到Python Package Index(PyPI)等情境都非常有意义。

打包Python项目

1、新建一个待打包的项目 

 完善项目结构,确保你的项目有一个良好的目录结构。通常情况下,一个标准的项目结构包括:

myproject/

|-- myproject/

|   |-- __init__.py

|   |-- module1.py

|   |-- module2.py

|-- tests/

|-- setup.py

|-- README.md

在这个例子中,myproject 是你的包的主目录,其中包含你的Python模块,tests 目录用于存放测试代码,setup.py 是用于描述包信息的文件,README.md 则用于提供项目的文档。

from setuptools import setup, find_packages

setup(
    name='myproject',
    version='0.1',
    packages=find_packages(),
    install_requires=[
        # 你的项目依赖的库
    ],
    entry_points={
        'console_scripts': [
            'myproject-cli = myproject.cli:main',
        ],
    },
)
setup.py

setup.py 是一个包含项目元数据的Python脚本,用于定义你的包。一个简单的 setup.py 文件可能如下所示:

这里,name 是你的包的名称,version 是你的包的版本,packages 是你的包含 Python 模块的目录,install_requires 包含你的项目依赖的其他包,entry_points 允许你添加一些命令行工具

 __init__.py 文件

在你的包的主目录中,确保有一个 __init__.py 文件。这个文件可以是空文件,但是必须存在,以便 Python 将该目录视为一个包。

2、执行打包项目

在你的项目根目录下打开终端,并执行以下命令

python setup.py sdist

这将创建一个源分发包,将包含在 dist/ 目录中。

python setup.py bdist_wheel

这将会创建一个wheel的文件。

3、上传到PyPI

如果你想分享你的包,可以将其上传到 PyPI(Python Package Index)。首先,确保你在 PyPI 上注册了账户。

然后,安装 twine

pip install twine

最后,使用 twine 上传你的包:

twine upload dist/*

这将上传你的源分发包到 PyPI。

其他人现在可以通过运行以下命令安装你的包:

pip install myproject

4、直接通过pip安装whl文件

如果你想内部其他项目使用你的包,可以通过whl文件进行安装

 

posted @ 2024-01-16 13:26  逍遥小天狼  阅读(33)  评论(0编辑  收藏  举报