Skip to main content
Strym Logo

Build Status Maintenance made-with-python made-with-sphinx-doc PyPI version shields.io PyPI license Downloads

bagpy

A Python package to facilitate the reading of a rosbag file based on semantic datatypes.

bagpy provides a wrapper class bagreader written in python that provides an easy to use interface for reading bag files recorded by rosbag record command. This wrapper class uses ROS's python API rosbag internally to perform all operations. One of the interesting features about using bagreader is that a user doesn't need to supply rostopic name to extract relevant data. One can extract data based on the type of data the user is seeking.

Requirements

  • Ubuntu 18.04 or later
  • Python 3.6 or higher. Now, the preferred version is Python 3.9. With other versions, there are some dependency issues as how pip works has changed.
  • Python 2.x support not available. Python 3.x virtual environment is recommended for pip installation.
  • Works with Windows as well, how, I don't provide support for Windows. See my comment on an issue here: https://github.com/jmscslgroup/bagpy/issues/2#issuecomment-710095649
  • Note: it is not compatible with ROS 2.

Installation

pip install bagpy

Usage principle

The philosophy behind developing this project is to make everything as simple and less confusing as possible. As a result, there are not too many options or freedom of usage being provided by bagreader class. If you need a wide variety of options, users can directly use ROS's rosbag python package or Robotics System Toolbox APIs provided by MATLAB. However, if you are looking for simplicity, bagpy is an elegant choice.

Examples

See Notebooks and python scripts at https://github.com/jmscslgroup/bagpy/tree/master/notebook for examples.

Metadata

Release files for bagpy 0.5

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

Built distribution (wheel)

Table of built distributions (wheels) for bagpy 0.5
File Interpreter ABI Platform
bagpy-0.5-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / bagpy-0.5-py2.py3-none-any.whl

Download URL bagpy-0.5-py2.py3-none-any.whl
Size 14.5 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
42789cdc0e35bbb1a0490a47becaa96adcc42258edc0b8cf7a4747589bef1c47
BLAKE2b-256 checksum
How to use checksums
f5cc0743a31317afb9aeba7ed02f06fce8ff6ce5a60b9c30023c70dcdd98488d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

Release history Release notifications | RSS feed

This release

0.5 This release

1 release file

0.4.10

1 release file

0.4.9

1 release file

0.4.8

1 release file

0.4.7

1 release file

0.4.6

1 release file

0.4.5

1 release file

0.4.4

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4

1 release file

0.3.15

1 release file

0.3.14

1 release file

0.3.13

1 release file

0.3.12

1 release file

0.3.11

1 release file

0.3.10

1 release file

0.3.9

1 release file

0.3.8

1 release file

0.3.7

1 release file

0.3.6

1 release file

0.3.5

1 release file

0.3.4

1 release file

0.3.3

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.5

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2

1 release file

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