This package provides Python 3 bindings for ArmarX,
including client classes for common interfaces.
[[_TOC_]]
[[_TOC_]]
---
---
## Installation
# Foreword
### Using Axii
**Python ArmarX - A Python Toolbox for ArmarX**
Add and upgrade the module `armarx/python3-armarx` in Axii.
This package provides Python 3 bindings for ArmarX,
including client classes for common interfaces to core functionalities
**Note:** The module is also included in the `armarx` module,
which is added to new workspaces by default.
```shell
# Terms and Concepts
axii workspace add armarx/python3-armarx
axii workspace upgrade -m armarx/python3-armarx
```
The main structure by this package can be illustrated like this:
### From Source Using Pip
{...}
To install the ArmarX Python bindings into your virtual environment:
```shell
source .venv/bin/activate
# armarx__python3_armarx__PATH = Path to python3-armarx
pip install-e$armarx__python3_armarx__PATH
```
The `-e` flag is optional.
# Structure of this Package
If you pass the `-e` flag to pip, it will install the package in _editable_ mode,
which means that you do not have to reinstall the package if you update or change
the ArmarX python bindings.
On the code level, this package contains the following libraries and components:
## Usage
## Libraries
- The [core library](source/armarx/externalization/core) with common data types and their conversions.
# Usage Example
The following examples show how to connect to a proxy provided by ArmarX framework in general, as well as specialized use cases such as obtaining images, control the robot, read from and write to memory, etc.
