{ "info": { "author": "Hordur K Heidarsson", "author_email": "hordur@hordur.us", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Topic :: Utilities" ], "description": "# rosbag_metadata\nTool for collecting and writing metadata to ROS bagfiles or to accompanying\nyaml files.\n\n## System metadata\n\nThe tool collects various system metadata by default and saves along with the\nuser entered data. The purpose of this is to be able to figure out what\nversions of software, os, etc. was running at the time of the bag recording.\n\nEach category of system metadata can be disabled through command line options.\n\nCurrently, the following data is saved:\n\n* ROS distribution info and package versions\n* Information on git repositories within ```ROS_PACKAGE_PATH```\n* Environmental variables\n* Network interfaces and IP address information\n* Connected USB devices\n\n## Examples\n\n### Reading\n\nDisplay metadata from a bag file:\n\n```rosbag_metadata mybag.bag```\n\nLook for metadata in a directory:\n\n```rosbag_metadata /path/to/dir```\n\nFirst it searches for /path/to/dir/metadata.yaml, followed by\n inspecting .bag files for /metadata topic. Displays the first hit unless\n```--find-all``` is specified.\n\nRead matadata from a yaml file:\n\n```rosbag_metadata file.yaml```\n\n### Writing\n\nWrite data to a bag file:\n\n```rosbag_metadata -w mybag.bag```\n\nWrite data to a yaml file:\n\n```rosbag_metadata -w file.yaml -t templatefile.yaml```\n\nWrite data to directory:\n\n```rosbag_metadata -w /path/to/dir --write-rosbag-info```\n\n```--write-rosbag-info``` will cause ```.bag``` files in the directory to be\ninspected with ```rosbag info``` and the resulting information will be added to\nthe metadata. This option does not work when the target is a bag file.\n\n### Templates\n\nTemplate files are simpy yaml files with key pairs that will be used as default\nkeys and values if defined. If a template is used the default behavior of\nrosbag_metadata is to not ask for values of keys defined with defaults in the\ntemplate. This behavior can be overwritten using the ```--ask-template-defaults```\nor per template item basis (see example template).\n\n```\ndescription: {value: My experiment, ask: 1}\noperator: Mr. User\nlocation: Building X\n```\n\n## Configuration\n\nThe template, default keys, system metadata settings and more can be configured\nin a config file. By default, rosbag_metadata will look for a config file\n```~/.ros/rosbag_metadata.conf```. Users can also specify a config file with the\n```-c/--config``` option.\n\n### Example config\n\nThe following config includes all the possible configuration options.\nDefault fields can be configured both via template and in the config file.\n\n```\n[config]\nclean = no\nwrite_rosbag_info = yes\nsystem_info = yes\nsystem_info_all = no\nsystem_info_usb = yes\nsystem_info_git = yes\nsystem_info_ros = yes\nsystem_info_env = yes\nsystem_info_full_env = no\nsystem_info_ip = yes\nfind_all = yes\ndebug = no\nask_template_defaults = no\ntemplate = ~/.ros/my_template.yaml\nextra_fields = no\nno_prompt = yes\n\n[default_fields]\nmy_default_field\nanother_field = with_value\n```\n\n## Future direction\n\nThe original idea for this project is to be able to easily catalog bag files and datasets\nrecorded using ROS. This is the first step of that process. The to-do list includes\nscripts to regularly index bag files in set folders and summarize to a database.\nThe metadata information generated by rosbag_metadata would be used as well as practical\ndata from the bag files themselves, such as GPS locations and camera images that could\nmake it easier to understand the dataset quickly.\n\n## More documentation:\n\nhttp://rosbag-metadata.readthedocs.org/ (work in progress)", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://rosbag-metadata.readthedocs.org/", "keywords": "ros rosbag metadata", "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "rosbag_metadata", "package_url": "https://pypi.org/project/rosbag_metadata/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/rosbag_metadata/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://rosbag-metadata.readthedocs.org/" }, "release_url": "https://pypi.org/project/rosbag_metadata/0.1.7/", "requires_dist": null, "requires_python": null, "summary": "Tool for collecting and writing metadata to ROS bagfiles or to accompanying yaml files.", "version": "0.1.7" }, "last_serial": 1469679, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "6781a19919cb5d0c177160286486cdb7", "sha256": "5bbb78242ef5b6b5b9a0fd03f700555cd475bf1a7c9689371edd82f9a7000ea4" }, "downloads": -1, "filename": "rosbag_metadata-0.1.2.tar.gz", "has_sig": false, "md5_digest": "6781a19919cb5d0c177160286486cdb7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10905, "upload_time": "2015-03-18T07:12:55", "url": "https://files.pythonhosted.org/packages/86/83/0b24e6ed6d8b280042d8db393d3a9a0a5e4283e52266883eb6a765685198/rosbag_metadata-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "bc6d12fc6119277a1bd6f188ea54da13", "sha256": "93733aa3fb0a8d376f2f333df83318f315a40a4f5ba77c255ed6108653225584" }, "downloads": -1, "filename": "rosbag_metadata-0.1.3.tar.gz", "has_sig": false, "md5_digest": "bc6d12fc6119277a1bd6f188ea54da13", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12460, "upload_time": "2015-03-18T07:20:28", "url": "https://files.pythonhosted.org/packages/76/f2/8f60a15df217b157dbc8a499fd82f1a01b2be5f0baab81d86141a12c6ccb/rosbag_metadata-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "fac1ef5b1adb03d2d7437686319a8ce0", "sha256": "0b3e578f93b4057f08c86542e65b051fa8a3bb8fe2f648c67be9dbd6f96b6392" }, "downloads": -1, "filename": "rosbag_metadata-0.1.4.tar.gz", "has_sig": false, "md5_digest": "fac1ef5b1adb03d2d7437686319a8ce0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12464, "upload_time": "2015-03-18T07:31:15", "url": "https://files.pythonhosted.org/packages/2d/0f/6173ac578e31779f0f599b08b25c47304afdf435622b054bd5b5afbbe6e6/rosbag_metadata-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "b6496a4eedcf2696fe48731b6398b914", "sha256": "a04e7299638aed94c7d7fa27137150b190d09631fbf6d8c50054ff596cf9cc04" }, "downloads": -1, "filename": "rosbag_metadata-0.1.5.tar.gz", "has_sig": false, "md5_digest": "b6496a4eedcf2696fe48731b6398b914", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12465, "upload_time": "2015-03-18T07:35:03", "url": "https://files.pythonhosted.org/packages/2e/6b/0d41a8613f60aa211dd01761788c6d275c2e1eab0bfcf07a0af496e4f99c/rosbag_metadata-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "a19446121648401716c112dc8e350ed6", "sha256": "b600c6e3ed0783c2f1fb18d364008bd0d35eb046d065fc6c5e0ec247d7e9437d" }, "downloads": -1, "filename": "rosbag_metadata-0.1.6.tar.gz", "has_sig": false, "md5_digest": "a19446121648401716c112dc8e350ed6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12477, "upload_time": "2015-03-18T07:38:59", "url": "https://files.pythonhosted.org/packages/3e/6c/75b6e439b205801332b0981ba08249b5dcd2578a66cd03547d9ef2447a67/rosbag_metadata-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "10507967d601af898213b7419f0b1a22", "sha256": "d88608f5d9e0cc067e8482a45ee94228a1ed1b4e169b0f0978e2ca97b0493067" }, "downloads": -1, "filename": "rosbag_metadata-0.1.7.tar.gz", "has_sig": false, "md5_digest": "10507967d601af898213b7419f0b1a22", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12519, "upload_time": "2015-03-20T11:10:28", "url": "https://files.pythonhosted.org/packages/e8/25/53a85cd4745fcf1c4f8a3bfd6c9f1c9437835f89b740abc40786be6d0465/rosbag_metadata-0.1.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "10507967d601af898213b7419f0b1a22", "sha256": "d88608f5d9e0cc067e8482a45ee94228a1ed1b4e169b0f0978e2ca97b0493067" }, "downloads": -1, "filename": "rosbag_metadata-0.1.7.tar.gz", "has_sig": false, "md5_digest": "10507967d601af898213b7419f0b1a22", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12519, "upload_time": "2015-03-20T11:10:28", "url": "https://files.pythonhosted.org/packages/e8/25/53a85cd4745fcf1c4f8a3bfd6c9f1c9437835f89b740abc40786be6d0465/rosbag_metadata-0.1.7.tar.gz" } ] }