Metadata-Version: 1.1
Name: roslibpy
Version: 0.3.0
Summary: Python ROS Bridge library.
Home-page: https://github.com/gramaziokohler/roslibpy
Author: Gramazio Kohler Research
Author-email: gramaziokohler@arch.ethz.ch
License: MIT license
Description: ============================
        roslibpy: ROS Bridge library
        ============================
        
        
        
        **Python ROS Bridge library** allows to use Python and IronPython to interact
        with `ROS <http://www.ros.org>`_, the open-source robotic middleware.
        It uses WebSockets to connect to
        `rosbridge 2.0 <http://wiki.ros.org/rosbridge_suite>`_ and provides publishing,
        subscribing, service calls, actionlib, TF, and other essential ROS functionality.
        
        Unlike the `rospy <http://wiki.ros.org/rospy>`_ library, this does not require a
        local ROS environment, allowing usage from platforms other than Linux.
        
        The API of **roslibpy** is modeled to closely match that of `roslibjs <http://wiki.ros.org/roslibjs>`_.
        
        
        Main features
        -------------
        
        * Topic publishing and subscribing.
        * Service calls (client).
        * Service advertisement (server).
        * ROS parameter management (get/set/delete).
        * ROS API services for getting ROS meta-information.
        * Actionlib support for interfacing with preemptable tasks.
        * TF Client via the ``tf2_web_republisher``.
        
        **Roslibpy** runs on Python 2.7 and 3.x and IronPython 2.7.
        
        
        Installation
        ------------
        
        To install **roslibpy**, simply use ``pip``::
        
            pip install roslibpy
        
        For IronPython, the ``pip`` command is slightly different::
        
            ipy -X:Frames -m pip install --user roslibpy
        
        Remember that you will need a working ROS setup including the
        **rosbridge server** and **TF2 web republisher** accessible within your network.
        
        
        Documentation
        -------------
        
        The full documentation, including examples and API reference
        is available on `readthedocs <https://roslibpy.readthedocs.io/>`_.
        
        
        Contributing
        ------------
        
        Make sure you setup your local development environment correctly:
        
        * Clone the `roslibpy <https://github.com/gramaziokohler/roslibpy>`_ repository.
        * Create a virtual environment.
        * Install development dependencies:
        
        ::
        
            pip install -r requirements-dev.txt
        
        **You're ready to start coding!**
        
        During development, use `pyinvoke <http://docs.pyinvoke.org/>`_ tasks on the
        command line to ease recurring operations:
        
        * ``invoke clean``: Clean all generated artifacts.
        * ``invoke check``: Run various code and documentation style checks.
        * ``invoke docs``: Generate documentation.
        * ``invoke test``: Run all tests and checks in one swift command.
        * ``invoke``: Show available tasks.
        
        For more details, check the *Contributor's Guide* available as part of `the documentation <https://roslibpy.readthedocs.io/>`_.
        
        
        Releasing this project
        ----------------------
        
        Ready to release a new version **roslibpy**? Here's how to do it:
        
        * We use `semver <http://semver.org/>`_, i.e. we bump versions as follows:
        
          * ``patch``: bugfixes.
          * ``minor``: backwards-compatible features added.
          * ``major``: backwards-incompatible changes.
        
        * Update the ``CHANGELOG.rst`` with all novelty!
        * Ready? Release everything in one command:
        
        ::
        
            invoke release [patch|minor|major]
        
        * Profit!
        
        
        Changelog
        =========
        
        All notable changes to this project will be documented in this file.
        
        The format is based on `Keep a Changelog <http://keepachangelog.com/en/1.0.0/>`_
        and this project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html>`_.
        
        0.3.0
        ----------
        
        **Changed**
        
        * Unsubscribing from a listener no longer requires the original callback to be passed.
        
        0.2.1
        ----------
        
        **Fixed**
        
        * Fix JSON serialization error on TF Client (on Python 3.x)
        
        0.2.0
        ----------
        
        **Added**
        
        * Add support for IronPython 2.7
        
        **Changed**
        
        * Handler ``on_ready`` now defaults to run the callback in thread
        
        **Deprecated**
        
        * Rename ``run_event_loop`` to the more fitting ``run_forever``
        
        0.1.1
        ----------
        
        **Fixed**
        
        * Minimal documentation fixes
        
        0.1.0
        ----------
        
        **Added**
        
        * Initial version
        
Keywords: ros,ros-bridge,robotics,websockets
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Topic :: Scientific/Engineering
