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

Uploaded Source

Built Distribution

encord-0.1.122-py3-none-any.whl (185.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.122.tar.gz
Algorithm Hash digest
SHA256 6ddcc088077c396b5c623ac78522ff34e986945bd1f267e73cae6a9774040b1f
MD5 283d13ff1907143e446a04448a742556
BLAKE2b-256 7fe9a814d9c763ecd654997bbd0dd42f11166d532b11a3f784d120f7809e7cc8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.122-py3-none-any.whl
Algorithm Hash digest
SHA256 0fe47e9a4b0f7f45f3504c4f5734f704ece1a94a73d72eeb9236dd60cbe989d4
MD5 1236d6cfbc791b34377d194b9d47d228
BLAKE2b-256 488ef495337f4c4c1aff7974971e7a818d151538a0270a357102e62b8d5acc8b

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