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

Uploaded Source

Built Distribution

encord-0.1.112-py3-none-any.whl (158.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.112.tar.gz
Algorithm Hash digest
SHA256 9ac380cb9c33d1f95560a3def6959acf16c99fbbf85a28c29b700d5702a1aa17
MD5 fcab359c220763cf1abe3efcd420273d
BLAKE2b-256 ca443f877a5159ae4437766c87ee568f70bff0ddcc135e11331899a9464d788a

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.112-py3-none-any.whl
Algorithm Hash digest
SHA256 8b08a31cf8fce9e173a1868a18fd0fe4b6fb8b82f0f051a439e16a7ad2863bf2
MD5 71860708eb64fa82df5eb3f6b79cc926
BLAKE2b-256 f9cb89cf163e0a2c34c7c70ec67314941f565f4fb00ca9b80bb5be9d80261b27

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