Merge pull request #18 from open-dynamic-robot-initiative/fkloss/rele…

…ase2

Release 2.0.1

.gitignore

@@ -1,4 +1,5 @@
 *.pyc
 build/
+dist/
 *.egg-info
 .DS_Store

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 
+## [2.0.1] - 2024-07-30
 ### Changed
 - Converted to pure Python package.  You can still use the package in a colcon workspace
   as before, but it is now also possible to install it with pip.
@@ -21,6 +22,8 @@
 
 There is no changelog for this or earlier versions.
 
+---
 
-[Unreleased]: https://github.com/open-dynamic-robot-initiative/robot_properties_fingers/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/open-dynamic-robot-initiative/robot_properties_fingers/compare/v2.0.1...HEAD
+[2.0.1]: https://github.com/open-dynamic-robot-initiative/robot_properties_fingers/compare/v1.1.0...v2.0.1
 [1.1.0]: https://github.com/open-dynamic-robot-initiative/robot_properties_fingers/releases/tag/v1.1.0

README.md

@@ -1,11 +1,13 @@
 Models of the (Tri-)Finger Robots
 =================================
 
-This package contains XACRO and mesh files for the various Finger and TriFinger
+This package contains URDF and mesh files for the various Finger and TriFinger
 robots as well as some Python utils to work with the models.
 
 For each finger type there is a model for a single finger and one for the
 TriFinger which simply consists of three times the single finger.
 
 For more information, see the
 [documentation](https://open-dynamic-robot-initiative.github.io/robot_properties_fingers).
+
+![Screenshots of the different (Tri-)Finger models](doc/images/all_finger_types.jpg)

doc_mainpage.rst

@@ -1,7 +1,9 @@
-``robot_properties_fingers`` contains the xacro model files for the various
+``robot_properties_fingers`` contains the URDF model files for the various
 :doc:`(Tri-)Finger robots <trifinger_docs:index>` as well as some Python utils
 to work with them.
 
+.. image:: doc/images/all_finger_types.jpg
+   :alt: Screenshots of the different (Tri-)Finger models
 
 The source code is hosted on GitHub_.  Please also use the `Bug Tracker`_ there
 if you have a question or want to report a bug.

package.xml

@@ -2,8 +2,8 @@
 <?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
 <package format="3">
     <name>robot_properties_fingers</name>
-    <version>1.2.0</version>
-    <description>Xacro files and meshes of the (Tri-)Finger robots.</description>
+    <version>2.0.1</version>
+    <description>URDF files and meshes of the (Tri-)Finger robots.</description>
     <maintainer email="[email protected]">Felix Widmaier</maintainer>
     <license>BSD-3-Clause</license>
 

setup.py

@@ -37,9 +37,15 @@ 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="1.2.0",
+    version="2.0.1",
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     package_data={"robot_properties_fingers": ["meshes/*.stl", "meshes/**/*.stl"]},
@@ -54,19 +60,27 @@ def run(self) -> None:
         ),
     ],
     install_requires=[
-        "setuptools",
         "xacro",
         "pin",  # pinocchio
     ],
     extras_require={"test": ["pytest"]},
     zip_safe=True,
     maintainer="Felix Kloss",
     maintainer_email="[email protected]",
-    description="Xacro files and meshes of the (Tri-)Finger robots.",
+    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={
         "console_scripts": [],
     },
     cmdclass={"build_py": CustomBuildCommand},
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python :: 3",
+        "Topic :: Scientific/Engineering",
+    ],
 )