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

Uploaded Source

Built Distribution

encord-0.1.149-py3-none-any.whl (220.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.149.tar.gz
  • Upload date:
  • Size: 173.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/5.15.0-1074-azure

File hashes

Hashes for encord-0.1.149.tar.gz
Algorithm Hash digest
SHA256 8826ed8f0414e5a0d7255162cd6e26c03399839a2aff848e70ff2286c9c7b36f
MD5 d02fc9b5f82da9b17b7fb483aa32c021
BLAKE2b-256 e28a2cc17255da7f64666d2984506eb944ee36b8287ffc4c241af59575765726

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.149-py3-none-any.whl
Algorithm Hash digest
SHA256 781c68bdd122b5a4b822a6c34311b6c43e93382360fdd6c7e6695fc42430b365
MD5 d424b66cbde39fe81fdafd4f0c3b7eb7
BLAKE2b-256 775a394cebc6b345515d7d7bcf32356e090ad178b146d5c259ce486295a3a17f

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