在Python中,setup()
函数是用于从setuptools
库创建和分发Python包的关键部分
- 首先,确保已经安装了
setuptools
库。如果尚未安装,请使用以下命令进行安装:
pip install setuptools
-
创建一个名为
setup.py
的文件,该文件将包含有关您的包的所有元数据和依赖关系。 -
在
setup.py
文件中,导入setuptools
库并定义setup()
函数。确保将正确的值传递给此函数,以便正确描述您的包。以下是一个简单的示例:
from setuptools import setup, find_packages setup( name="your_package_name", version="0.1", packages=find_packages(), install_requires=[ # 添加您的包所需的依赖项列表 "dependency1", "dependency2", ], entry_points={ # 如果需要,可以定义命令行接口 "console_scripts": [ "your-command = your_package_name.main:main_function", ], }, author="Your Name", author_email="your.email@example.com", description="A brief description of your package", long_description=open("README.md").read(), long_description_content_type="text/markdown", url="https://github.com/yourusername/your-package-name", classifiers=[ # 提供有关您的包的元数据,例如支持的Python版本和许可证 "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], )
- 使用
setuptools
构建和分发您的包。首先,在命令行中运行以下命令以创建源代码和wheel分发文件:
python setup.py sdist bdist_wheel
- 安装您的包到本地Python环境:
pip install --upgrade --force-reinstall dist/your_package_name-0.1.tar.gz
或者安装wheel文件:
pip install --upgrade --force-reinstall dist/your_package_name-0.1-py3-none-any.whl
- 将您的包发布到Python Package Index (PyPI)。首先,确保您已在pypi.org上注册了一个帐户。然后,在命令行中运行以下命令:
twine upload dist/*
现在,其他人可以通过pip install your_package_name
命令安装和使用您的包了。