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

Uploaded Source

Built Distribution

encord-0.1.134-py3-none-any.whl (215.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.134.tar.gz
  • Upload date:
  • Size: 164.9 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.134.tar.gz
Algorithm Hash digest
SHA256 3a441a3e5c4118210c6799c70ec2ce651afcce31575f787d64ac579186e883eb
MD5 8bc2188b37891a34c16709ca896b5a7c
BLAKE2b-256 44a9c746cb86eb0a76c476f6b6268d9faadc111a63aa402881d3e1bc3210a5bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.134-py3-none-any.whl
  • Upload date:
  • Size: 215.7 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.134-py3-none-any.whl
Algorithm Hash digest
SHA256 39ed032b7de057eaab39dd61691079069a03becb7191568c3bcae2b9def69a76
MD5 375fc39dae79da60466494fe9dc3b78a
BLAKE2b-256 3f818eb24e6d7256cdba301a026e72d2e8de3ce88fa463b15de9380756e42828

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