Metadata-Version: 2.4
Name: telekinesis-isaacsim-client
Version: 0.1.1
Summary: Python bindings for the Telekinesis Isaac Sim bridge client with C++ core.
Author-Email: Telekinesis <support@telekinesis.ai>
License-Expression: LicenseRef-Proprietary
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Project-URL: Homepage, https://telekinesis.ai
Project-URL: Documentation, https://docs.telekinesis.ai
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: pybind11-stubgen; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Provides-Extra: dev-windows
Requires-Dist: delvewheel; extra == "dev-windows"
Description-Content-Type: text/markdown

<div align="center">
  <p>
    <a align="center" href="https://telekinesis.ai" target="_blank">
      <img
        width="100%"
        src="https://telekinesis-public-assets.s3.us-east-1.amazonaws.com/Telekinesis+Banner.png"
      >
    </a>
  </p>

  <br>

[Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples) | [Documentation](https://docs.telekinesis.ai)
<br>

[![PyPI version](https://img.shields.io/pypi/v/telekinesis-isaac-sim)](https://pypi.org/project/telekinesis-isaac-sim/)
[![License](https://img.shields.io/pypi/l/telekinesis-isaac-sim)](https://pypi.org/project/telekinesis-isaac-sim/)
[![Python versions](https://img.shields.io/pypi/pyversions/telekinesis-isaac-sim)](https://pypi.org/project/telekinesis-isaac-sim/)
[![Platform](https://img.shields.io/badge/platform-Windows-blue)](https://pypi.org/project/telekinesis-isaac-sim/)
[![Platform](https://img.shields.io/badge/macOS%20%7C%20Linux-coming%20soon-lightgrey)](https://pypi.org/project/telekinesis-isaac-sim/)

</div>

<p align="center">
  <a href="https://github.com/telekinesis-ai">GitHub</a>
  &nbsp;•&nbsp;
  <a href="https://www.linkedin.com/company/telekinesis-ai/">LinkedIn</a>
  &nbsp;•&nbsp;
  <a href="https://x.com/telekinesis_ai">X</a>
  &nbsp;•&nbsp;
  <a href="https://discord.gg/7NnQ3bQHqm">Discord</a>
</p>

# Telekinesis Isaac Sim

**Telekinesis Isaac Sim** is a Python client for the Telekinesis Isaac Sim bridge,
built on a C++ core.

## Installation

It's highly recommended to install into a dedicated Conda environment:
```powershell
conda create -n isaacsimclient python=3.12
conda activate isaacsimclient
```

Then install the package:
```powershell
pip install telekinesis-isaacsim-client
```

## Example Usage

```python
from telekinesis.isaacsim_client import IsaacSimClient

client = IsaacSimClient(
    api_key="",
    base_url="http://127.0.0.1:8766",
    websocket_base_url="ws://127.0.0.1:8766",
)

created = client.articulation.create("/World/ur10e")
print(created["articulation_id"])

client.articulation.set_joint_positions(created["articulation_id"], [0.0] * created["num_dof"])
```

More examples will soon be available on [Telekinesis IsaacSim Examples](https://github.com/telekinesis-ai/isaacsim-examples)

## Resources

- [Documentation](https://docs.telekinesis.ai): full API reference and guides.

## Support

- Open an [issue](https://github.com/telekinesis-ai/telekinesis-isaac-sim/issues) on GitHub.
- Email: support@telekinesis.ai
- [Discord](https://discord.com/invite/7NnQ3bQHqm)

## License

Proprietary. © Telekinesis. All rights reserved.
