如何制作自己的本地python库（windows）

---

前言

项目中经常会需要用到各文件中python函数和类的相互的调用，为了保证代码的整洁，我们可以将一些常用的代码发布制作成自己的代码库，实际项目中使用只需要直接导入即可。本文就如何发布制作自己的python 库做一个详细的介绍

提示：如果您不熟悉Python的模块和导入包，请花几分钟时间阅读包含文件包和模块的Python文档(https://docs.python.org/3/tutorial/modules.html#packages)

步骤

1.项目准备

要在本地创建此项目，请创建以下文件结构，本文以创建库 ShareClass 为例：

/项目文件夹
  /ShareClass
    __init__.py
    helloworld.py

新建项目文件夹（命名随意），并在文件夹内创建以库名ShareClass命名的子文件夹，在ShareClass内新建py文件，命名为__init__.py

2.创建包文件

在项目文件夹中添加内容（setup.py 文件必须，LICENSE 和 README.md 可选）。

/项目文件夹
  /ShareClass
    __init__.py
  LICENSE
  README.md

3.创建setup.py

setup.py是setuptools的构建脚本。它告诉setuptools你的包（例如名称和版本）以及要包含的代码文件。在 ShareClass 库文件夹中创建 setup.py 并打开输入以下内容：软件包名称、用户名等（可以按照实际情况个性化其他值）：

import setuptools


setuptools.setup(
    name="ShareClass",
    version="1.0",
    author="Beall",
    author_email="beallhuang@163.com",
    description="",
    long_description="ShareClass",
    long_description_content_type="ShareClass",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
)

setup()需要几个论点。此示例包使用相对最小的集：
setuptools 是一个优秀的，可靠的 Pthon 包安装与分发工具，可使用命令安装

pip install setuptools

name是包的分发名称。只要包含字母，数字_和，就可以是任何名称-。它也不能在pypi.org上使用。请务必使用您的用户名更新此内容，因为这可确保您在上传程序包时不会遇到任何名称冲突。
version 是包版本看 PEP 440有关版本的更多详细信息。
author并author_email用于识别包的作者。
description 是一个简短的，一句话的包的总结。
long_description是包的详细说明。这显示在Python Package Index的包详细信息包中。在这种情况下，加载长描述README.md是一种常见模式。
long_description_content_type告诉索引什么类型的标记用于长描述。在这种情况下，它是Markdown。
url是项目主页的URL。对于许多项目，这只是一个指向GitHub，GitLab，Bitbucket或类似代码托管服务的链接。
packages是应包含在分发包中的所有Python 导入包的列表。我们可以使用 自动发现所有包和子包，而不是手动列出每个包。在这种情况下，包列表将是example_pkg，因为它是唯一存在的包。find_packages()
classifiers告诉索引并点一些关于你的包的其他元数据。在这种情况下，该软件包仅与Python 3兼容，根据MIT许可证进行许可，并且与操作系统无关。您应始终至少包含您的软件包所使用的Python版本，软件包可用的许可证以及您的软件包将使用的操作系统。
有关详细信息，请参阅 打包和分发项目。

4.生成分发档案

现在从setup.py位于的同一目录运行此命令：

python setup.py sdist

此命令应输出大量文本，一旦完成，应在dist目录中生成文件：

dist/
  ShareClass-1.0.tar.gz

5.安装代码库

进入到dist文件夹，使用PIP 安装库

cd ./dist
pip install .\ShareClass-1.0.tar.gz

即可完成python 库的安装

完成以上步骤我们就可以在以后的python 代码中导入自制的库

from ShareClass import helloworld