Metadata-Version: 2.3
Name: encord
Version: 0.1.200
Summary: Encord Python SDK Client
Keywords: encord
Author: Cord Technologies Limited
Author-email: Cord Technologies Limited <hello@encord.com>
License: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Dist: python-dateutil>=2.8.2,<3.0.0
Requires-Dist: requests>=2.25.0,<3.0.0
Requires-Dist: cryptography>=43.0.0
Requires-Dist: tqdm>=4.32.1,<5.0.0
Requires-Dist: pydantic>=1.10.14
Requires-Dist: orjson>=2
Requires-Dist: typing-extensions>=4.0.0
Requires-Dist: pycocotools>=2.0.7,<3.0.0 ; extra == 'coco'
Requires-Dist: shapely>=2.0.4,<3.0.0 ; extra == 'coco'
Requires-Dist: opencv-python>=4.11.0.86,<5.0.0.0 ; extra == 'coco'
Requires-Dist: numpy>=1.24,<2.0.0 ; python_full_version < '3.12' and extra == 'coco'
Requires-Dist: numpy>=1.26,<2.0.0 ; python_full_version >= '3.12' and extra == 'coco'
Requires-Dist: mcap>=0.4.0 ; extra == 'mcap'
Requires-Dist: mcap-protobuf-support>=0.5.0 ; extra == 'mcap'
Requires-Dist: mcap-ros2-support>=0.5.0 ; extra == 'mcap'
Requires-Dist: pillow>=10.0.0 ; extra == 'mcap'
Requires-Dist: protobuf>=4.0.0 ; extra == 'mcap'
Requires-Python: >=3.9, <3.15
Project-URL: documentation, https://docs.encord.com/sdk-documentation/getting-started-sdk/sdk-intro
Project-URL: repository, https://github.com/encord-team/encord-client-python
Provides-Extra: coco
Provides-Extra: mcap
Description-Content-Type: text/markdown

<h1 align="center">
  <p align="center">Encord Python API Client</p>
  <a href="https://encord.com">
    <img src="https://storage.googleapis.com/docs-media.encord.com/encord.png" width="280" alt="Encord logo"/>
  </a>
</h1>

[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# Encord is the multimodal data layer for physical AI. Manage, curate, annotate, and align petabytes of data - from sensor streams to video to text.

## 💻 Features

- Minimal low-level Python client that allows you to interact with Encord's API
- Supports Python: `3.9`, `3.10`, `3.11`, `3.12`, `3.13` and `3.14`

## ✨ Relevant Links

* [Encord website](https://encord.com)
* [Encord web app](https://app.encord.com)
* [Encord documentation](https://docs.encord.com)

## 💡 Getting Started

For full documentation, please visit [Encord Python SDK](https://docs.encord.com/sdk-documentation/getting-started-sdk/installation-sdk).

First, install Encord Python API Client using the [pip](https://pip.pypa.io/en/stable/installing) package manager:

```bash
python3 -m pip install encord
```

Some functionality is available through optional extras. Install them if you need COCO import/export or MCAP support:

```bash
# COCO import/export helpers (pycocotools, shapely, opencv, numpy)
python3 -m pip install "encord[coco]"

# MCAP support (mcap, protobuf, Pillow)
python3 -m pip install "encord[mcap]"
```

Then, create a service account, generate a key pair, and register the public key in the Encord platform.
Detailed guide can be found in the [dedicated manual](https://docs.encord.com/platform-documentation/GettingStarted/getting-started-service-accounts).

Pass the path to your private key when initializing the Encord client:

```python
# Import dependencies
from encord import EncordUserClient

# Authenticate with Encord using the path to your private key.  Replace <private_key_path> with the path to your private key.
user_client = EncordUserClient.create_with_ssh_private_key(
  ssh_private_key_path="<private_key_path>"
)
```

For detailed example code and SDK reference material refer to [Encord SDK documentation](https://docs.encord.com/sdk-documentation/getting-started-sdk/sdk-intro)

## 🐛 Troubleshooting

Please report bugs to the [GitHub Issues](https://github.com/encord-team/encord-client-python/issues).
Just make sure you read the [Encord documentation](https://docs.encord.com) and search for related issues first.
