Skip to main content

Encord Python SDK Client

Project description

Encord Python API Client

Encord 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.8, 3.9, 3.10 and 3.11

✨ Relevant Links

💡 Getting Started

For full documentation, please visit Encord Python SDK.

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

python3 -m pip install encord

Then, generate an public-private key pair, and upload the public key to Encord website. Detailed guide can be found in the dedicated manual.

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

# 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 examples and API reference please refer to Encord SDK documentation

🐛 Troubleshooting

Please report bugs to the 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.128.tar.gz (158.1 kB view details)

Uploaded Source

Built Distribution

encord-0.1.128-py3-none-any.whl (206.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.128.tar.gz
  • Upload date:
  • Size: 158.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.8.18 Linux/5.15.0-1068-azure

File hashes

Hashes for encord-0.1.128.tar.gz
Algorithm Hash digest
SHA256 7ebc2eeb4240469bdcf436c6148e634807535bc2a8bcd20d0683f776ed1a6efb
MD5 6198431947e867bfa28bc4e20bad047b
BLAKE2b-256 20816f1d60ae2b575b15ad8bff40c86a66a289bb26f749ce55851e502461f2b6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.128-py3-none-any.whl
  • Upload date:
  • Size: 206.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.8.18 Linux/5.15.0-1068-azure

File hashes

Hashes for encord-0.1.128-py3-none-any.whl
Algorithm Hash digest
SHA256 38146856d72c05821f1dc402c09dc8338bb25243491cfac33f9885da4a7bb2fd
MD5 126cede93d143133423c9e3e117d9ccf
BLAKE2b-256 a69804e8bc8874620db053c6168c804e1833a7dd1a7a85dbeca064e9da79cb63

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