From 7d8fa70771f0d0878fd5930090db083dcbe34d95 Mon Sep 17 00:00:00 2001 From: Felix Kloss Date: Tue, 30 Jul 2024 10:52:12 +0200 Subject: [PATCH] setup.py: Load README as long_description So it should be displayed on PyPI. --- setup.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/setup.py b/setup.py index c833178..ad908f1 100644 --- a/setup.py +++ b/setup.py @@ -37,6 +37,12 @@ def run(self) -> None: urdf_file.write_text(urdf_content) +def load_readme() -> str: + """Load the README file.""" + this_directory = pathlib.Path(__file__).parent + return (this_directory / "README.md").read_text() + + setup( name=package_name, version="2.0.0", @@ -62,6 +68,9 @@ def run(self) -> None: maintainer="Felix Kloss", maintainer_email="felix.kloss@tue.mpg.de", description="URDF files and meshes of the (Tri-)Finger robots.", + long_description=load_readme(), + long_description_content_type="text/markdown", + url="https://open-dynamic-robot-initiative.github.io/robot_properties_fingers/", license="BSD-3-Clause", tests_require=["pytest"], entry_points={