Skip to content

Commit

Permalink
setup.py: Load README as long_description
Browse files Browse the repository at this point in the history
So it should be displayed on PyPI.
  • Loading branch information
luator committed Jul 30, 2024
1 parent b42ad10 commit 7d8fa70
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -62,6 +68,9 @@ def run(self) -> None:
maintainer="Felix Kloss",
maintainer_email="[email protected]",
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={
Expand Down

0 comments on commit 7d8fa70

Please sign in to comment.