-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
setup.py: Load README as long_description
So it should be displayed on PyPI.
- Loading branch information
Showing
1 changed file
with
9 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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="[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={ | ||
|