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, visit Encord Python API Client.

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.35.tar.gz (40.8 kB view details)

Uploaded Source

Built Distribution

encord-0.1.35-py3-none-any.whl (57.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.35.tar.gz
  • Upload date:
  • Size: 40.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.6

File hashes

Hashes for encord-0.1.35.tar.gz
Algorithm Hash digest
SHA256 1319e47ffe6f3d887307ce496513e1847279c1367649cef2218505013fb31e1f
MD5 2c1e8ab090bbb11ac71aa487403ed91d
BLAKE2b-256 5fbe4346f493ade9f4f38986a16e2b4098c3528f753fcd050f6c27f17423b003

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.35-py3-none-any.whl
  • Upload date:
  • Size: 57.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.25.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.7.6

File hashes

Hashes for encord-0.1.35-py3-none-any.whl
Algorithm Hash digest
SHA256 607647838416e09efd87fbe6e5f82b5e7e27a84c577a184cb0dab97ee9a891eb
MD5 f72429f3ed57b73c0368629266b589d4
BLAKE2b-256 47ffcc5c2f327e7945a984cffcf65d67fea7b2d98c937d49a611a5900c4fa2e4

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