Metadata-Version: 2.4
Name: encord
Version: 0.1.178
Summary: Encord Python SDK Client
Project-URL: repository, https://github.com/encord-team/encord-client-python
Project-URL: documentation, https://python.docs.encord.com/
Author-email: Cord Technologies Limited <hello@encord.com>
License: Apache Software License
License-File: LICENSE
Keywords: encord
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: cryptography>=43.0.0
Requires-Dist: orjson>=2
Requires-Dist: pydantic>=1.10.14
Requires-Dist: python-dateutil<3.0.0,>=2.8.2
Requires-Dist: requests<3.0.0,>=2.25.0
Requires-Dist: tqdm<5.0.0,>=4.32.1
Provides-Extra: coco
Requires-Dist: numpy<2.0.0,>=1.24; (python_version < '3.12') and extra == 'coco'
Requires-Dist: numpy<2.0.0,>=1.26; (python_version >= '3.12') and extra == 'coco'
Requires-Dist: opencv-python<5.0.0.0,>=4.11.0.86; extra == 'coco'
Requires-Dist: pycocotools<3.0.0,>=2.0.7; extra == 'coco'
Requires-Dist: shapely<3.0.0,>=2.0.4; extra == 'coco'
Provides-Extra: dev
Requires-Dist: deepdiff<9.0.0,>=8.6.1; extra == 'dev'
Requires-Dist: mypy<2.0.0,>=1.11.1; extra == 'dev'
Requires-Dist: numpy<2.0.0,>=1.24; (python_version < '3.12') and extra == 'dev'
Requires-Dist: numpy<2.0.0,>=1.26; (python_version >= '3.12') and extra == 'dev'
Requires-Dist: opencv-python<5.0.0.0,>=4.11.0.86; extra == 'dev'
Requires-Dist: pre-commit<4.0.0,>=3.5.0; extra == 'dev'
Requires-Dist: pycocotools<3.0.0,>=2.0.7; extra == 'dev'
Requires-Dist: pyright<2.0.0,>=1.1.374; extra == 'dev'
Requires-Dist: pytest<8.0.0,>=7.4.1; extra == 'dev'
Requires-Dist: ruff<0.9.0,>=0.8.6; extra == 'dev'
Requires-Dist: shapely<3.0.0,>=2.0.4; extra == 'dev'
Requires-Dist: types-python-dateutil<3.0.0,>=2.8.19; extra == 'dev'
Requires-Dist: types-requests<3.0.0,>=2.25.0; extra == 'dev'
Requires-Dist: types-tqdm<5.0.0,>=4.32.1; extra == 'dev'
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)

# The data engine for computer vision

## 💻 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` and `3.13`

## ✨ 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
```

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

Passing the private key to the factory, you can initialise the Encord client directly.

```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.
