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

Uploaded Source

Built Distribution

encord-0.1.68-py3-none-any.whl (122.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.68.tar.gz
Algorithm Hash digest
SHA256 425277ee36f41aed14c71d85e4b7d823f0d05a532d4fab658c3e2038eefcc06e
MD5 fb2cfc7e762f69a43989e57edf27a557
BLAKE2b-256 0c00e3bc780c81c03f1e4c8663f50ad6da560d24866690d2926b3d0e6b90cf71

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.68-py3-none-any.whl
Algorithm Hash digest
SHA256 4d5827ecb45f22b4bae75cd85b01b04cb5b6cfe8e418c2162144847f58a02d6c
MD5 3375c3d47048214517dd37d19d611c95
BLAKE2b-256 f74868a3385f2ca75e683a8b0d204e2dea7ffad39b935b1ce5ec34f283f40a35

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