Metadata-Version: 2.4
Name: telekinesis-applications
Version: 0.0.1rc5
Summary: Official applications package for the Telekinesis SDK and APIs.
Author-email: Telekinesis <support@telekinesis.ai>
License-Expression: LicenseRef-Proprietary
Project-URL: Homepage, https://telekinesis.ai
Project-URL: Documentation, https://docs.telekinesis.ai
Project-URL: Telekinesis Examples Repository, https://github.com/telekinesis-ai/telekinesis-examples
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
Requires-Dist: loguru>=0.5.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: rerun-sdk>=0.31.2
Requires-Dist: open3d>=0.18.0
Requires-Dist: octomap-python>=1.9.0
Requires-Dist: telekinesis-ai[medulla-realsense]>=0.2.15
Requires-Dist: telekinesis-dataengine[lerobot]
Provides-Extra: docs
Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
Requires-Dist: mkdocstrings[python]<1,>=0.25; extra == "docs"
Requires-Dist: mkdocs-awesome-pages-plugin<3,>=2; extra == "docs"
Provides-Extra: dev
Requires-Dist: ruff==0.15.8; extra == "dev"
Requires-Dist: pylint==4.0.5; extra == "dev"

<div align="center">
  <p>
    <a align="center" href="" target="_blank">
      <img
        width="100%"
        src="https://assets.telekinesis.ai/Telekinesis+Banner.png"
      >
    </a>
  </p>

  <br>

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

[![PyPI version](https://img.shields.io/pypi/v/telekinesis-applications)](https://pypi.org/project/telekinesis-applications/)
[![License](https://img.shields.io/pypi/l/telekinesis-applications)](https://pypi.org/project/telekinesis-applications/)
[![Python versions](https://img.shields.io/pypi/pyversions/telekinesis-applications)](https://pypi.org/project/telekinesis-applications/)

</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 Applications

Telekinesis Applications is a package providing application-level building blocks on top of the Telekinesis SDK, for robotics and computer vision use cases within the Telekinesis ecosystem.

## Requirements
Current support for Python versions - `3.11`, `3.12`.

**Note**
- Telekinesis Applications is currently in its early development phase (pre-1.0).
- There will be continuous **version updates**. To have the latest features, please always install or upgrade to the **latest version of the package.**

## Installation

1. Create an isolated environment so that there is no dependency conflicts. We recommend installing `Miniconda` environment by following instructions from [here](https://docs.conda.io/en/latest/miniconda.html#installing).

2. Create a new `conda` environment called `telekinesis-applications`:
    ```bash
    conda create -n telekinesis-applications python=3.11
    ```

3. Activate the environment:
    ```bash
    conda activate telekinesis-applications
    ```

4. Install the core SDK using `pip`:

    ```bash
    pip install telekinesis-applications
    ```

    Note: The Python module is provided under the `telekinesis` namespace as `telekinesis.applications`, while the package published on PyPI is `telekinesis-applications`.

## Example

```python
from telekinesis import applications

sorter = applications.SortingApplication()
```

## Resources

- Examples
  Runnable usage examples for Telekinesis Applications: [Telekinesis Examples](https://github.com/telekinesis-ai/telekinesis-examples)

- Documentation
  Full SDK documentation and usage details: [Telekinesis Documentation](https://docs.telekinesis.ai)

## Support

For issues and questions:
- Create an [issue](https://github.com/telekinesis-ai/telekinesis-examples/issues) in the GitHub repository.
- Contact the Telekinesis development team at support@telekinesis.ai or on [Discord](https://discord.com/invite/7NnQ3bQHqm).
