Skip to content

Commit 386d5c5

Browse files
README: Consolidate; Use spaces instead of tabs
Update CHANGELOG for deprecating internal XML stuff
1 parent 97bc2f3 commit 386d5c5

File tree

3 files changed

+34
-40
lines changed

3 files changed

+34
-40
lines changed

CHANGELOG.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
Changelog for package urdfdom_py
33
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
44

5+
* Deprecate internal details of `xml_reflection` classes.
6+
57
0.4.0 (2018-02-21)
68
------------------
79
* Add Link.visual and Link.collision properties (`#28 <https://github.com/ros/urdf_parser_py/issues/28>`_)

README.md

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,37 @@
11
# urdf_parser_py
22

3-
## Development Setup
3+
## Authors
44

5-
You must manually run `setup.py`. For catkin development, you can install to $ws/../build/lib/pythonX.Y/dist-packages via
5+
* Thomas Moulard - `urdfpy` implementation, integration
6+
* David Lu - `urdf_python` implementation, integration
7+
* Kelsey Hawkins - `urdf_parser_python` implementation, integration
8+
* Antonio El Khoury - bugfixes
9+
* Eric Cousineau - reflection
10+
* Ioan Sucan
11+
* Jackie Kay
12+
* Chris LaLancette (maintainer)
13+
* Shane Loretz (maintainer)
614

7-
devel_prefix=$(cd $(catkin_find --first-only)/.. && pwd)
8-
cd ../urdf_parser_py
9-
python setup.py install --install-layout deb --prefix $devel_prefix
15+
## Features
1016

11-
## Authors
17+
* URDF
18+
* SDF (very basic coverage)
19+
* XML Saving / Loading
20+
* Some attempts to preserve original ordering; comments are stripped out,
21+
however.
22+
23+
## Todo
24+
25+
1. Deprecate public access to `xml_reflection`.
26+
2. Make a direct, two-way URDF <-> SDF converter when kinematics are not an
27+
issue.
28+
29+
## Development Setup
30+
31+
For ease of developing, you may manually run `setup.py`.
32+
For catkin development, you can install to
33+
`${ws}/../build/lib/pythonX.Y/dist-packages` via:
1234

13-
* Thomas Moulard - `urdfpy` implementation, integration
14-
* David Lu - `urdf_python` implementation, integration
15-
* Kelsey Hawkins - `urdf_parser_python` implementation, integration
16-
* Antonio El Khoury - bugfixes
17-
* Eric Cousineau - reflection update
18-
19-
## Reflection
20-
21-
This an attempt to generalize the structure of the URDF via reflection to make it easier to extend. This concept is taken from Gazebo's SDF structure, and was done with SDF in mind to a) make an SDF parser and b) make a simple converter between URDF and SDF.
22-
23-
### Changes
24-
25-
* Features:
26-
* Transmission and basic Gazebo nodes.
27-
* General aggregate types, preserving order
28-
* Dumping to YAML, used for printing to string (dictionaries do not preserve attribute ordering)
29-
* XML Parsing: minidom has been swapped out with lxml.etree, but it should not be hard to change that back. Maybe Sax could be used for event-driven parsing.
30-
* API:
31-
* Loading methods rely primarily on instance methods rather than static methods, mirroring Gazebo's SDF construct-then-load method
32-
* Renamed static `parse_xml()` to `from_xml()`, and renamed `load_*` methods to `from_*` if they are static
33-
34-
### Todo
35-
36-
1. Support additional formats (SDF, drakeURDF, etc.)
37-
* Parse Gazebo's SDF definition files at some point? For speed's sake, parse it and have it generate code to use?
38-
* Consider auto-generating modules from schemas such as [urdf.xsd](https://github.com/ros/urdfdom/blob/master/xsd/urdf.xsd). This can extend to [SDF](http://sdformat.org/schemas/model.xsd), [drakeURDF](https://github.com/RobotLocomotion/drake/blob/master/drake/doc/drakeURDF.xsd).
39-
2. Make a direct, two-way URDF <-> SDF converter.
40-
* Gazebo has the ability to load URDFs and save SDFs, but it lumps everything together
41-
3. Consider a cleaner implementation for reflection.
42-
* Make the names a little clearer, especially the fact that `from_xml` and `to_xml` write to a node, but do not create a new one.
43-
* Abstraction layer is not clear. Should explicitly use abstract classes, and try to really clarify the dispatch order (`xmlr.Element`, `xmlr.Param`, `xmlr.Object`, etc.)
44-
4. Figure out good policy for handling default methods. If saving to XML, write out default values, or leave them out for brevity (and to leave it open for change)? Might be best to add that as an option.
45-
5. Find a lightweight package that can handle the reflection aspect more elegantly. Enthought traits? IPython's spinoff of traits?
35+
devel_prefix=$(cd $(catkin_find --first-only)/.. && pwd)
36+
cd ../urdf_parser_py
37+
python setup.py install --install-layout deb --prefix ${devel_prefix}

package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<author>David Lu</author>
1111
<author>Kelsey Hawkins</author>
1212
<author>Antonio El Khoury</author>
13-
<author>Eric Cousineau</author>
13+
<author email="eacousineau@gmail.com">Eric Cousineau</author>
1414
<author email="isucan@gmail.com">Ioan Sucan</author>
1515
<author email="jacquelinekay1@gmail.com">Jackie Kay</author>
1616

0 commit comments

Comments
 (0)