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

Uploaded Source

Built Distribution

encord-0.1.75-py3-none-any.whl (126.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.75.tar.gz
  • Upload date:
  • Size: 101.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.7.12 Linux/5.15.0-1036-azure

File hashes

Hashes for encord-0.1.75.tar.gz
Algorithm Hash digest
SHA256 df283a2686d13e4e339c2d9cf044d9b1598c3f6dc068ff1c2977647ebab93fe3
MD5 3b9825bdfb651adecf4647ef8ffc1191
BLAKE2b-256 b8a168957e8daefde843a7c26949f2cb231a291eaf264f90afec8935873f28b1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.75-py3-none-any.whl
Algorithm Hash digest
SHA256 bf688ad9a304f21d0e775230cf6f865998ec09c84bbf4142cc87a36b5716e862
MD5 937f6a2c4aa6d423b33d19dd3b4764bc
BLAKE2b-256 1f75707c915d3038a45dd3530ef9a7f6c350b564db4dd392baa009154e592592

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