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

Uploaded Source

Built Distribution

encord-0.1.145-py3-none-any.whl (216.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.145.tar.gz
  • Upload date:
  • Size: 170.5 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.145.tar.gz
Algorithm Hash digest
SHA256 2a02173ec731e8627087e1623639a41da3d5b63fafd07acfc7fb494fc6b22d6b
MD5 1aa09a23f31546b698dc964a3158b124
BLAKE2b-256 53d51dccb344d6caf74f1101a3a50e1ffae6ef1661b8fe82e8b1a1c2e165dba4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.145-py3-none-any.whl
  • Upload date:
  • Size: 216.9 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.145-py3-none-any.whl
Algorithm Hash digest
SHA256 c8b4a27add978bec02a67927cd1e3edb6f9f703140d1f5dc5bf680e331a584fa
MD5 71ea57b42338e8d8698621f57bfaf642
BLAKE2b-256 0390e953551d8aa5189f4d3139cd195ec91d0759187471e74c9e7beefe2f1a1e

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