Skip to main content

Encord Python SDK Client

Project description

Encord Python API Client

Cord logo

license

The data engine for computer vision

💻 Features

  • Minimal low-level Python client that allows you to interact with Encord's API
  • Supports Python: 3.7, 3.8, 3.9, and 3.10

✨ Relevant Links

💡 Getting Started

For full documentation, please visit Encord Python SDK.

First, install Encord Python API Client using the pip package manager:

pip install encord

Then, create an API key for authentication via the Encord web app. Pass the resource ID and API key as environment variables or pass them explicitly when you initialise the EncordClient object.

export ENCORD_PROJECT_ID="<project_id>"
export ENCORD_API_KEY="<project_api_key>"

Passing the resource ID and API key as environment variables, you can initialise the Encord client directly.

from encord.client import EncordClient

client = EncordClient.initialise()

If you want to avoid setting environment variables, you can initialise the Encord client by passing the resource ID and API key as strings.

from encord.client import EncordClient

client = EncordClient.initialise("<resource_id>", "<resource_api_key>")

If you wish to instantiate several client objects and avoid passing parameters each time, you can instantiate a EncordConfig object, pass the resource ID and API key as strings, and initialise the client with the config object.

from encord.client import EncordClient
from encord.client import EncordConfig

config = EncordConfig("<resource_id>", "<resource_api_key>")
client = EncordClient.initialise_with_config(config)

Once you have instantiated an Encord client, it is easy to fetch information associated with the given resource ID.

from encord.client import EncordClient

client = EncordClient.initialise()
project = client.get_project()

🐛 Troubleshooting

Please report bugs to GitHub Issues. Just make sure you read the Encord documentation and search for related issues first.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

encord-0.1.53.tar.gz (59.4 kB view details)

Uploaded Source

Built Distribution

encord-0.1.53-py3-none-any.whl (83.4 kB view details)

Uploaded Python 3

File details

Details for the file encord-0.1.53.tar.gz.

File metadata

  • Download URL: encord-0.1.53.tar.gz
  • Upload date:
  • Size: 59.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.12 Linux/5.15.0-1022-azure

File hashes

Hashes for encord-0.1.53.tar.gz
Algorithm Hash digest
SHA256 76840f3d2ffec06f83719aa351e54487b04ff4881bbda839208aa8a7ce4fb764
MD5 b25c5b24a9e736282c264f5df39a64b0
BLAKE2b-256 8e1006283bf4385817d9dae94538b73e311dd4cdcb31dd302b7d500102899b73

See more details on using hashes here.

File details

Details for the file encord-0.1.53-py3-none-any.whl.

File metadata

  • Download URL: encord-0.1.53-py3-none-any.whl
  • Upload date:
  • Size: 83.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.12 Linux/5.15.0-1022-azure

File hashes

Hashes for encord-0.1.53-py3-none-any.whl
Algorithm Hash digest
SHA256 19bcaebf65372a5ec1cd38217d1ff100b3285cc05a695ca04db1eead0f2002fb
MD5 f9fa75e3f130a37b0c11c040fd45ca11
BLAKE2b-256 e0ee4b3efc304fa455da7b26d9034e9cd53b76c458958553b11b84878d740c62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page