Skip to main content
pipeline status coverage report python versions PyPI - Downloads

Rosbags

Rosbags is the pure python library for everything rosbag. It contains:

  • highlevel easy-to-use interfaces,

  • rosbag2 reader and writer,

  • rosbag1 reader and writer,

  • extensible type system with serializers and deserializers,

  • efficient converter between rosbag1 and rosbag2,

  • and more.

Rosbags does not have any dependencies on the ROS software stacks and can be used on its own or alongside ROS1 or ROS2.

Rosbags was developed for MARV, which requires a fast, correct, and flexible library to read, manipulate, and write the various rosbag file formats.

Getting started

Rosbags is published on PyPI and does not have any special dependencies. Simply install with pip:

pip install rosbags

Read and deserialize messages from rosbag1 or rosbag2 files:

from pathlib import Path

from rosbags.highlevel import AnyReader
from rosbags.typesys import Stores, get_typestore

bagpath = Path('/home/ros/rosbag_2020_03_24')

# Create a type store to use if the bag has no message definitions.
typestore = get_typestore(Stores.ROS2_FOXY)

# Create reader instance and open for reading.
with AnyReader([bagpath], default_typestore=typestore) as reader:
    connections = [x for x in reader.connections if x.topic == '/imu_raw/Imu']
    for connection, timestamp, rawdata in reader.messages(connections=connections):
         msg = reader.deserialize(rawdata, connection.msgtype)
         print(msg.header.frame_id)

Convert between rosbag versions:

# Convert "foo.bag", result will be "foo/"
rosbags-convert foo.bag

# Convert "bar", result will be "bar.bag"
rosbags-convert bar

# Convert "foo.bag", save the result as "bar"
rosbags-convert foo.bag --dst /path/to/bar

# Convert "bar", save the result as "foo.bag"
rosbags-convert bar --dst /path/to/foo.bag

Documentation

Read the documentation for further information.

Contributing

Thank you for considering to contribute to rosbags.

To submit issues or create merge requests please follow the instructions provided in the contribution guide.

By contributing to rosbags you accept and agree to the terms and conditions laid out in there.

Development

Clone the repository and setup your local checkout:

git clone https://gitlab.com/ternaris/rosbags.git

cd rosbags
uv sync

This creates a new virtual environment with the necessary python dependencies and installs rosbags in editable mode. The rosbags code base uses pytest as its test runner, run the test suite by simply invoking:

uv run pytest

To build the documentation from its source run sphinx-build:

uv run sphinx-build -a docs public

The entry point to the local documentation build should be available under public/index.html.

Support

Professional support is available from Ternaris.

Metadata

Release files for rosbags 0.11.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rosbags 0.11.10
File Size Uploaded Provenance Actions
rosbags-0.11.10.tar.gz 350.7 kB Without provenance Details for rosbags-0.11.10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rosbags 0.11.10
File Interpreter ABI Platform Actions
rosbags-0.11.10-py3-none-any.whl Python 3 none any Details for rosbags-0.11.10-py3-none-any.whl

Total release size: 501.8 kB

Release files / rosbags-0.11.10.tar.gz

Download URL rosbags-0.11.10.tar.gz
Size 350.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a49fafcf5595fa6ca589b10a317618a383825c0102cd55979ebdeb45006158c6
BLAKE2b-256 checksum
How to use checksums
bf7968c6bec49961b43a571a5be87b9b6ba41b7958195f458df0ccf56d5cbb4a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / rosbags-0.11.10-py3-none-any.whl

Download URL rosbags-0.11.10-py3-none-any.whl
Size 151.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
63dba16f7b075ab9efb5fbad81e3dd22aad3397ebc3d1f54722f80c80836b6da
BLAKE2b-256 checksum
How to use checksums
09e79960cd47cab9a7a16e99196422dcafdcb94b632bec9de2ba39a8df14873d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for rosbags 0.11.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.11.10 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page