Add long description and content type for proper PyPI presentation (#1361)
This commit adds the two fields `long_description` and `long_description_content_type` to `setup.py`. These can be used for proper project presentation on the PyPI project page, which is currently a placeholder.
diff --git a/setup.py b/setup.py
index 13e4d61..f6b3568 100644
--- a/setup.py
+++ b/setup.py
@@ -16,6 +16,10 @@
IS_WINDOWS = sys.platform.startswith("win")
+with open("README.md", "r", encoding="utf-8") as fp:
+ long_description = fp.read()
+
+
def _get_version():
"""Parse the version string from __init__.py."""
with open(
@@ -118,6 +122,8 @@
version=_get_version(),
url="https://github.com/google/benchmark",
description="A library to benchmark code snippets.",
+ long_description=long_description,
+ long_description_content_type="text/markdown",
author="Google",
author_email="benchmark-py@google.com",
# Contained modules and scripts.
