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

Uploaded Source

Built Distribution

encord-0.1.136-py3-none-any.whl (221.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.136.tar.gz
  • Upload date:
  • Size: 169.0 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.136.tar.gz
Algorithm Hash digest
SHA256 cfc6134607c16e8948c703efc0cc56e5c99ce29f563dad1443397049d35796b0
MD5 340f000f373608a83c539f0fd331624c
BLAKE2b-256 612bf1db3b9984d4af401b1f31ff0be0d94d15242d4b9f499532c66c620987ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.136-py3-none-any.whl
  • Upload date:
  • Size: 221.0 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.136-py3-none-any.whl
Algorithm Hash digest
SHA256 7c355b7fa113d902c45f74bb1b8670b3ce85d3263532d9cfd31a0ce394046264
MD5 5673d6512e849f4a42c07e3c82014e87
BLAKE2b-256 b43bd1284983f9a1e59d004636060093e5b649e7a1247cba685d470f675402cd

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