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

Uploaded Source

Built Distribution

encord-0.1.138-py3-none-any.whl (213.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.138.tar.gz
Algorithm Hash digest
SHA256 5f969a127960650d56953dfe5918580fda76180bec6e9f0252efa636a42e3f5a
MD5 0f08da876da7e250389bd65d7971a1ae
BLAKE2b-256 31a8072db46d1248a638bc2bd5c2544091c0d850d843afe422e943f604632972

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.138-py3-none-any.whl
Algorithm Hash digest
SHA256 82611f34abd3871a93f37cd9a6b5805d22e172692ba5ebb7dca44fb0699da69b
MD5 abb0ba2ec87799df6eb3ff0e04ac06c4
BLAKE2b-256 404369489a75eb0bd3b9d2e8ecc68d89e5d4579dd482741f9a359495fad7b87f

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