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

Uploaded Source

Built Distribution

encord-0.1.126-py3-none-any.whl (202.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.126.tar.gz
Algorithm Hash digest
SHA256 7b3ebee4eaae6dcb7e199b1ca7a0f7c725eead35d2dce67056ccc38c358bf738
MD5 0ed9f17199ed18a65c0133d678f9b30f
BLAKE2b-256 e50fef3683345b009c34c702ebb6784cbda150502e873052398671a6bb0bee52

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.126-py3-none-any.whl
Algorithm Hash digest
SHA256 59a70aec19c0fa28cf30388522c3f2e802a6c8588bcf06b0fbba63b394973130
MD5 133196fd94ced765d12cbad99027c96d
BLAKE2b-256 338e7f95eb45944b2d48739bfd0c073cbb0d4691303037a1b083921eba13f5a9

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