Skip to content

Commit

Permalink
Prepping versioning to allow for release into Foxy
Browse files Browse the repository at this point in the history
  • Loading branch information
tpanzarella committed Jul 12, 2020
1 parent 8bf0134 commit 855e263
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
2.0.3 2020-07-12
----------------
* Renamed fork to ``ros2_numpy``
* Start tracking changes in CHANGELOG at 2.0.3
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,34 @@
# ros2_numpy
This project is a fork of [ros_numpy](https://github.com/eric-wieser/ros_numpy)
to work with ROS 2. It provides tools for converting ROS messages to and from
numpy arrays. Contains two functions:
numpy arrays. In the ROS 2 port, the module has been renamed to
`ros2_numpy`. Users are encouraged to update their application code to import
the module as shown below.

ROS 2:

```
import ros2_numpy as rnp
```

ROS 1:

```
import ros_numpy as rnp
```

Prefacing your calls like `rnp.numpify(...)` or `rnp.msgify(...)` should help
future proof your codebase while the ROS 1 and ROS 2 ports are API compatible.

The ROS 2 port has been bootstrapped as version `2.0.3`. The `MAJOR`
version has been set to `2` to indicate ROS 2 and the `MINOR` and `PATCH`
versions match the ROS 1 version from which the ROS 2 port was
bootstrapped. The reasoning behind this is to allow for creating tags in this
fork that can be released into the ROS 2 distribution while not conflicting
with existing tags on the upstream repository. A release into Foxy is still
pending.

This module contains two core functions:

* `arr = numpify(msg, ...)` - try to get a numpy object from a message
* `msg = msgify(MessageType, arr, ...)` - try and convert a numpy object to a message
Expand Down
10 changes: 6 additions & 4 deletions package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,19 @@
schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
<name>ros2_numpy</name>
<version>0.0.3</version>
<!-- MAJOR is 2 for ROS2 version -->
<version>2.0.3</version>
<description>A collection of conversion functions for extracting numpy arrays from messages</description>

<author email="wieser@mit.edu">Eric Wieser</author>
<!-- ROS 1 ros_numpy -->
<maintainer email="wieser@mit.edu">Eric Wieser</maintainer>
<!-- ROS 2 -->
<maintainer email="tom@boxrobotics.ai">Tom Panzarella</maintainer>

<license>MIT</license>

<url type="repository">https://github.com/Box-Robotics/ros2_numpy</url>
<!-- Github does not seem to allow a fork to have its own issue tracker -->
<url type="bugtracker">https://github.com/eric-wieser/ros_numpy/issues</url>

<exec_depend>python3-numpy</exec_depend>
<exec_depend>sensor_msgs</exec_depend>
<exec_depend>nav_msgs</exec_depend>
Expand Down

0 comments on commit 855e263

Please sign in to comment.