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

Uploaded Source

Built Distribution

encord-0.1.143-py3-none-any.whl (216.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.143.tar.gz
Algorithm Hash digest
SHA256 9b5dac10be74232be32b992780b6b05e0c2afcb1cf22030ddc943feaaafd6801
MD5 01d80ed11867624a6d4290469598f109
BLAKE2b-256 87966c19a206679cfeefa4eeb308cc3aa3e5d70a3d2edcc1d3c105295d63213d

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.143-py3-none-any.whl
Algorithm Hash digest
SHA256 1b69298c0d98b41879358c2a1f9c39aaa92f68a82c94ee79fbe5b79757803310
MD5 b8f344a3d4c2d518bfd7af2c0761a131
BLAKE2b-256 6b2c1c3c7cffb5f39a9ead04404cf5d157ce6547b5f566d3cd558651e318474e

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