Metadata-Version: 2.4
Name: telekinesis-deployment
Version: 0.0.1
Summary: Installer and CLI for the Telekinesis deployment stack.
Requires-Python: <3.13,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: docker==7.1.0
Requires-Dist: loguru==0.7.3
Requires-Dist: requests==2.33.1
Dynamic: license-file

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

  <br>

  [![Python versions](https://img.shields.io/badge/python-3.11%20%7C%203.12-blue)](https://www.python.org/)
  [![License](https://img.shields.io/badge/license-proprietary-lightgrey)](LICENSE.txt)
</div>

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

# Telekinesis Deployment

Telekinesis Deployment provides the installation tooling and backend delivery
workflows for the Telekinesis platform.

It includes:

- Cloud deployment to Amazon EKS using Helm
- Local, single-node, and evaluator deployment using Docker Compose
- A command-line interface for installing and managing Telekinesis services
- Shared configuration, health checks, licensing, and provisioning utilities

## Release Model

Telekinesis Deployment is currently in active development (pre-1.0). Features
and interfaces may evolve between minor releases. Use the version specified by
the Telekinesis development team for production deployments.

## Installation

1. Install [Miniconda](https://docs.conda.io/projects/miniconda/en/latest/) or
   another Python environment manager.

2. Clone this repository:

   ```bash
   git clone -b develop https://gitlab.com/telekinesis/deployment.git
   cd deployment
   ```

3. Create and activate a supported Python environment:

   > Telekinesis Deployment supports Python 3.11 and 3.12.

   ```bash
   conda create -n telekinesis-deployment python=3.11
   conda activate telekinesis-deployment
   ```

4. Install the CLI and its dependencies in editable mode:

   ```bash
   pip install -e .
   ```

5. Verify the installation:

   ```bash
   telekinesis server --help
   ```

## Example

Initialize a local deployment and start its services:

```bash
telekinesis server init
telekinesis server install
telekinesis server status
```

Use `telekinesis server init --profile developer` to initialize a developer
environment. Run `telekinesis server --help` to see all available commands.

## Deployment Modes

| Mode | When to use |
| --- | --- |
| [Cloud deployment](docs/helm/overview.md) | Deploy backend services to Amazon EKS with Helm |
| [Compose deployment](docs/compose/overview.md) | Run the backend locally, on a single server, or for evaluator installations |

## Resources

- [Development guide](DEVELOPMENT.md)
- [Installer documentation](docs/installer/overview.md)
- [Telekinesis documentation](https://docs.telekinesis.ai)
- [Release history](RELEASE.md)

## Support

For issues and questions, contact the Telekinesis development team at
[support@telekinesis.ai](mailto:support@telekinesis.ai) or join the
[Telekinesis Discord](https://discord.com/invite/7NnQ3bQHqm).

## License

This repository is proprietary and confidential. See [LICENSE.txt](LICENSE.txt)
for details.
