Metadata-Version: 2.4
Name: pybullet_robot
Version: 0.2.1
Summary: A general Python interface class for robot simulations using PyBullet. Also provides an IK interface for multi-end-effector robots that uses bullet physics as a solver.
Author-email: Saif Sidhik <mail@saifsidhik.page>
License-Expression: MIT
Project-URL: Homepage, https://github.com/justagist/pybullet_robot
Project-URL: Bug Tracker, https://github.com/justagist/pybullet_robot/issues
Project-URL: Documentation, https://github.com/justagist/pybullet_robot/blob/main/README.md
Project-URL: Source Code, https://github.com/justagist/pybullet_robot
Keywords: pybullet,robotics,simulation,inverse kinematics,robot control,python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: robot-descriptions<2,>=1.11.0
Requires-Dist: numpy<3,>=1.6
Requires-Dist: scipy<2,>=1.14.0
Requires-Dist: pybullet<4,>=3.2.6
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: build; extra == "dev"
Dynamic: license-file

# PyBullet Robot

[![PyPI version](https://badge.fury.io/py/pybullet-robot.svg)](https://badge.fury.io/py/pybullet-robot)

This package provides:
1. A generel Python interface class for robot simulations using [PyBullet](https://www.pybullet.org). Python API class to control and monitor the robot in the simulation.
2. A pybullet inverse kinematics interface that can be used for getting joint position values when end-effector/link targets are provided. Supports multi-end-effector targets and floating-base robots.


## Installation

### From PyPI

```bash
pip install pybullet_robot
```

### From source

```bash
git clone -b main https://github.com/justagist/pybullet_robot
cd pybullet_robot
pip install .
```

## Development

Install in editable mode with the development extras (test + lint + build tooling):

```bash
git clone -b main https://github.com/justagist/pybullet_robot
cd pybullet_robot
pip install -e ".[dev]"
```

A [dev container](.devcontainer/devcontainer.json) is provided for a reproducible
environment in VS Code ("Reopen in Container").

## Usage

(TODO)
