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

Uploaded Source

Built Distribution

encord-0.1.109-py3-none-any.whl (155.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.109.tar.gz
Algorithm Hash digest
SHA256 42863866e403608483b1814c1ff86aa9b3899dbd8467a03ed57f3a6f71e9b9b8
MD5 bd44498834a5458bbabc0087439338de
BLAKE2b-256 de3b174da968e52026d6f313f173b986e8abdc7178e1588618fa36539faecf57

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.109-py3-none-any.whl
Algorithm Hash digest
SHA256 8ecfd7bad907b947f910be0d28e6ed7b5489d3d33b8306f9df1849c76d17f2b9
MD5 7d972604ae106f415178395929d00e49
BLAKE2b-256 82350413bc65f1029147cbebe79384f5778412d7f562bb0ff7617a825be32ad0

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