Skip to content

Commit 855e263

Browse files
committed
Prepping versioning to allow for release into Foxy
1 parent 8bf0134 commit 855e263

File tree

3 files changed

+38
-5
lines changed

3 files changed

+38
-5
lines changed

Diff for: CHANGELOG.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2.0.3 2020-07-12
2+
----------------
3+
* Renamed fork to ``ros2_numpy``
4+
* Start tracking changes in CHANGELOG at 2.0.3

Diff for: README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,34 @@
11
# ros2_numpy
22
This project is a fork of [ros_numpy](https://github.com/eric-wieser/ros_numpy)
33
to work with ROS 2. It provides tools for converting ROS messages to and from
4-
numpy arrays. Contains two functions:
4+
numpy arrays. In the ROS 2 port, the module has been renamed to
5+
`ros2_numpy`. Users are encouraged to update their application code to import
6+
the module as shown below.
7+
8+
ROS 2:
9+
10+
```
11+
import ros2_numpy as rnp
12+
```
13+
14+
ROS 1:
15+
16+
```
17+
import ros_numpy as rnp
18+
```
19+
20+
Prefacing your calls like `rnp.numpify(...)` or `rnp.msgify(...)` should help
21+
future proof your codebase while the ROS 1 and ROS 2 ports are API compatible.
22+
23+
The ROS 2 port has been bootstrapped as version `2.0.3`. The `MAJOR`
24+
version has been set to `2` to indicate ROS 2 and the `MINOR` and `PATCH`
25+
versions match the ROS 1 version from which the ROS 2 port was
26+
bootstrapped. The reasoning behind this is to allow for creating tags in this
27+
fork that can be released into the ROS 2 distribution while not conflicting
28+
with existing tags on the upstream repository. A release into Foxy is still
29+
pending.
30+
31+
This module contains two core functions:
532

633
* `arr = numpify(msg, ...)` - try to get a numpy object from a message
734
* `msg = msgify(MessageType, arr, ...)` - try and convert a numpy object to a message

Diff for: package.xml

+6-4
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,19 @@
33
schematypens="http://www.w3.org/2001/XMLSchema"?>
44
<package format="3">
55
<name>ros2_numpy</name>
6-
<version>0.0.3</version>
6+
<!-- MAJOR is 2 for ROS2 version -->
7+
<version>2.0.3</version>
78
<description>A collection of conversion functions for extracting numpy arrays from messages</description>
89

910
<author email="[email protected]">Eric Wieser</author>
10-
<!-- ROS 1 ros_numpy -->
11-
<maintainer email="[email protected]">Eric Wieser</maintainer>
12-
<!-- ROS 2 -->
1311
<maintainer email="[email protected]">Tom Panzarella</maintainer>
1412

1513
<license>MIT</license>
1614

15+
<url type="repository">https://github.com/Box-Robotics/ros2_numpy</url>
16+
<!-- Github does not seem to allow a fork to have its own issue tracker -->
17+
<url type="bugtracker">https://github.com/eric-wieser/ros_numpy/issues</url>
18+
1719
<exec_depend>python3-numpy</exec_depend>
1820
<exec_depend>sensor_msgs</exec_depend>
1921
<exec_depend>nav_msgs</exec_depend>

0 commit comments

Comments
 (0)