.. image:: https://gitlab.com/ternaris/rosbags-dataframe/badges/master/pipeline.svg
:target: https://gitlab.com/ternaris/rosbags-dataframe/-/commits/master
:alt: pipeline status
.. image:: https://gitlab.com/ternaris/rosbags-dataframe/badges/master/coverage.svg
:target: https://gitlab.com/ternaris/rosbags-dataframe/-/commits/master
:alt: coverage report
=================
Rosbags-dataframe
=================
Rosbags-dataframe a python library to ease the create of pandas dataframes from rosbag messages. It is part of the larger `Rosbags <https://gitlab.com/ternaris/rosbags>`_ ecosystem.
Rosbags-dataframe does not have any dependencies on the ROS software stacks and can be used on its own or alongside ROS1 or ROS2.
Getting started
===============
Rosbags-dataframe is published on PyPI and does not have any special dependencies. Simply install with pip::
pip install rosbags-dataframe
Get a dataframe from a rosbag:
.. code-block:: python
from pathlib import Path
from rosbags.dataframe import get_dataframe
from rosbags.highlevel import AnyReader
with AnyReader([Path('test1.bag'), Path('test2.bag')]) as reader:
dataframe = get_dataframe(reader, '/gps', ['latitude', 'longitude'])
Documentation
=============
Read the `documentation <https://ternaris.gitlab.io/rosbags-dataframe/>`_ for further information.
.. end documentation
Contributing
============
Thank you for considering to contribute to rosbags-dataframe.
To submit issues or create merge requests please follow the instructions provided in the `contribution guide <https://gitlab.com/ternaris/rosbags-dataframe/-/blob/master/CONTRIBUTING.rst>`_.
By contributing to rosbags-dataframe 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-dataframe.git
cd rosbags-dataframe
python -m venv venv
. venv/bin/activate
pip install -r requirements-dev.txt
pip install -e .
This creates a new virtual environment with the necessary python dependencies and installs rosbags-dataframe in editable mode. The rosbags-dataframe code base uses pytest as its test runner, run the test suite by simply invoking::
pytest
To build the documentation from its source run sphinx-build::
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 <https://ternaris.com>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "rosbags-dataframe",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "conversion, dataframe, message, msg, pandas, ros, ros2, rosbag, rosbag1, rosbag2, rosbags, series",
"author": null,
"author_email": "Ternaris <team@ternaris.com>",
"download_url": "https://files.pythonhosted.org/packages/81/05/7c8090b744abfb1555f1442588a58be99c6c8f3448cdf6179f2bc964b697/rosbags_dataframe-0.10.0.tar.gz",
"platform": null,
"description": ".. image:: https://gitlab.com/ternaris/rosbags-dataframe/badges/master/pipeline.svg\n :target: https://gitlab.com/ternaris/rosbags-dataframe/-/commits/master\n :alt: pipeline status\n\n.. image:: https://gitlab.com/ternaris/rosbags-dataframe/badges/master/coverage.svg\n :target: https://gitlab.com/ternaris/rosbags-dataframe/-/commits/master\n :alt: coverage report\n\n\n=================\nRosbags-dataframe\n=================\n\nRosbags-dataframe a python library to ease the create of pandas dataframes from rosbag messages. It is part of the larger `Rosbags <https://gitlab.com/ternaris/rosbags>`_ ecosystem.\n\nRosbags-dataframe does not have any dependencies on the ROS software stacks and can be used on its own or alongside ROS1 or ROS2.\n\n\nGetting started\n===============\n\nRosbags-dataframe is published on PyPI and does not have any special dependencies. Simply install with pip::\n\n pip install rosbags-dataframe\n\n\nGet a dataframe from a rosbag:\n\n.. code-block:: python\n\n from pathlib import Path\n\n from rosbags.dataframe import get_dataframe\n from rosbags.highlevel import AnyReader\n\n with AnyReader([Path('test1.bag'), Path('test2.bag')]) as reader:\n dataframe = get_dataframe(reader, '/gps', ['latitude', 'longitude'])\n\n\nDocumentation\n=============\n\nRead the `documentation <https://ternaris.gitlab.io/rosbags-dataframe/>`_ for further information.\n\n.. end documentation\n\n\nContributing\n============\n\nThank you for considering to contribute to rosbags-dataframe.\n\nTo submit issues or create merge requests please follow the instructions provided in the `contribution guide <https://gitlab.com/ternaris/rosbags-dataframe/-/blob/master/CONTRIBUTING.rst>`_.\n\nBy contributing to rosbags-dataframe you accept and agree to the terms and conditions laid out in there.\n\n\nDevelopment\n===========\n\nClone the repository and setup your local checkout::\n\n git clone https://gitlab.com/ternaris/rosbags-dataframe.git\n\n cd rosbags-dataframe\n python -m venv venv\n . venv/bin/activate\n\n pip install -r requirements-dev.txt\n pip install -e .\n\n\nThis creates a new virtual environment with the necessary python dependencies and installs rosbags-dataframe in editable mode. The rosbags-dataframe code base uses pytest as its test runner, run the test suite by simply invoking::\n\n pytest\n\n\nTo build the documentation from its source run sphinx-build::\n\n sphinx-build -a docs public\n\n\nThe entry point to the local documentation build should be available under ``public/index.html``.\n\n\nSupport\n=======\n\nProfessional support is available from `Ternaris <https://ternaris.com>`_.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python library to convert ros message streams to pandas dataframes.",
"version": "0.10.0",
"project_urls": {
"Changelog": "https://gitlab.com/ternaris/rosbags-dataframe/-/blob/master/CHANGES.rst",
"Documentation": "https://ternaris.gitlab.io/rosbags-dataframe",
"Homepage": "https://gitlab.com/ternaris/rosbags-dataframe",
"Issues": "https://gitlab.com/ternaris/rosbags-dataframe/issues",
"Source": "https://gitlab.com/ternaris/rosbags-dataframe"
},
"split_keywords": [
"conversion",
" dataframe",
" message",
" msg",
" pandas",
" ros",
" ros2",
" rosbag",
" rosbag1",
" rosbag2",
" rosbags",
" series"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "973e76f7e6f8719ebe4ef737d8e176a477bac80273936ae0798c74911d187281",
"md5": "0e9ae8cfe05c2f2a4e67e08bf5adbbe2",
"sha256": "d865c15ad674808b28d16e26cbd8612f3134145c4b9bac485e2b253ede5dc90a"
},
"downloads": -1,
"filename": "rosbags_dataframe-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e9ae8cfe05c2f2a4e67e08bf5adbbe2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8499,
"upload_time": "2024-05-30T16:26:25",
"upload_time_iso_8601": "2024-05-30T16:26:25.511469Z",
"url": "https://files.pythonhosted.org/packages/97/3e/76f7e6f8719ebe4ef737d8e176a477bac80273936ae0798c74911d187281/rosbags_dataframe-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "81057c8090b744abfb1555f1442588a58be99c6c8f3448cdf6179f2bc964b697",
"md5": "e1a74332e212e98ab8f7db53b0e5c390",
"sha256": "b0ccfbf9bda27de8588bdc722409508cc9f0bf4199a0d29796eed686b1a4daf0"
},
"downloads": -1,
"filename": "rosbags_dataframe-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "e1a74332e212e98ab8f7db53b0e5c390",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 49484,
"upload_time": "2024-05-30T16:26:27",
"upload_time_iso_8601": "2024-05-30T16:26:27.493898Z",
"url": "https://files.pythonhosted.org/packages/81/05/7c8090b744abfb1555f1442588a58be99c6c8f3448cdf6179f2bc964b697/rosbags_dataframe-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-30 16:26:27",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "ternaris",
"gitlab_project": "rosbags-dataframe",
"lcname": "rosbags-dataframe"
}
JSON