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

Uploaded Source

Built Distribution

encord-0.1.156-py3-none-any.whl (242.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.156.tar.gz
  • Upload date:
  • Size: 193.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.18 Linux/5.15.0-1078-azure

File hashes

Hashes for encord-0.1.156.tar.gz
Algorithm Hash digest
SHA256 56faf7f441032823ea1f303ee0f557cb743ef75c78b8c0f1d3e8e106d9d080f7
MD5 faf1ed0e28cbf4b6a8c927980f5921b9
BLAKE2b-256 0df1f63c69d7ec53b185efff1bae5f34efccf5220626e25cc5c8c572d7220807

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.156-py3-none-any.whl
Algorithm Hash digest
SHA256 a9064c6be023b9d78973410dadf54a4676da8944eaee754008c5d62947676055
MD5 898c22d685e289366d18032df13e4ec6
BLAKE2b-256 cfaaeeaa65f412ece7da98b942f5821ab968aa9788ec06cfbc91f8cbbda5f825

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page