Installation Guide

Prerequisites

  • Python 3.8 or higher
  • pip (Python package installer)

System Architecture

Before installing, it's helpful to understand the overall architecture of the Python ROS Engine:

graph TD
    A[Python ROS Engine] --> B[Core Functionality]
    A --> C[Bridging Capabilities]
    B --> B1[Node Management]
    B --> B2[Publishers/Subscribers]
    B --> B3[Services/Clients]
    B --> B4[Parameters]
    B --> B5[Timers]
    C --> C1[ROS1 Bridge]
    C --> C2[Message Translation]

Installation Methods

To install the Python ROS Engine from PyPI, simply run:

pip install python-ros-engine

From Source

If you want to install from source, first clone the repository:

git clone https://github.com/yhbcode000/python-ros-engine.git
cd python-ros-engine

Then install the package:

pip install .

Development Installation

For development purposes, you can install the package in editable mode with test dependencies:

pip install -e .[test]

This will install all dependencies needed for development and testing.

Verifying Installation

After installation, you can verify that the package is correctly installed by running:

python -c "import pyros2; print('Python ROS Engine installed successfully')"

Running Tests

To run the tests, you'll need to install the test dependencies:

pip install -e .[test]

Then run the tests with pytest:

python -m pytest tests/ -v