在Python中,setup()
函数通常与setuptools
库一起使用,用于安装和分发Python模块
- 首先,确保已经安装了
setuptools
库。如果尚未安装,可以使用以下命令安装:
pip install setuptools
- 创建一个名为
setup.py
的文件,将以下内容粘贴到该文件中:
from setuptools import setup, find_packages setup( name="your-package-name", version="0.1", packages=find_packages(), install_requires=[ # 添加项目依赖项,例如: # "numpy", # "pandas" ], entry_points={ # 如果需要,可以添加命令行接口 }, author="Your Name", author_email="your.email@example.com", description="A short description of your package", long_description=open("README.md").read(), long_description_content_type="text/markdown", url="https://github.com/yourusername/your-repo-name", classifiers=[ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", ], )
请根据您的项目需求自行修改上述内容。
-
在项目的根目录下创建一个名为
README.md
的文件,添加有关项目的详细说明。 -
要在本地安装此包,请在命令行中导航到包含
setup.py
文件的目录,然后运行以下命令:
python setup.py install
这将安装您在setup.py
中指定的依赖项。
-
如果您想将项目发布到PyPI(Python Package Index),则需要执行以下步骤:
- 确保满足PyPI的指南和要求。
- 在
setup.py
中添加python_requires
参数,指定支持的Python版本:
python_requires=">=3.6",
- 生成源代码和wheel分发文件:
python setup.py sdist bdist_wheel
- 安装
twine
库(用于将包上传到PyPI):
pip install twine
- 登录到您的PyPI帐户:
twine login
- 将包上传到PyPI:
twine upload dist/*
现在,其他人可以通过pip install your-package-name
命令安装您的Python包。