在setup.py哪里添加long_description字符串
时间: 2024-05-18 07:17:40 浏览: 106
在 `setup.py` 中,你可以将 `long_description` 字段添加到 `setup()` 函数中。例如:
```python
from setuptools import setup
setup(
name="example-project",
version="0.1",
description="An example Python project",
long_description="This is a longer description of the example project.",
long_description_content_type="text/plain",
url="https://github.com/example/example-project",
author="Your Name",
author_email="your.email@example.com",
packages=["example_project"],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.6",
)
```
在这个例子中,我们使用了纯文本格式的长描述,并将其类型设置为 `text/plain`。如果你使用 Markdown 格式的长描述,你可以将类型设置为 `text/markdown`。注意,你也可以在 `setup.py` 文件中引用一个单独的文件,这个文件包含了长描述。例如:
```python
from setuptools import setup
with open("README.md", "r") as fh:
long_description = fh.read()
setup(
name="example-project",
version="0.1",
description="An example Python project",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/example/example-project",
author="Your Name",
author_email="your.email@example.com",
packages=["example_project"],
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
python_requires=">=3.6",
)
```
在这个例子中,我们使用了 `README.md` 文件作为长描述,并将类型设置为 `text/markdown`。
阅读全文