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.9, 3.10, 3.11, 3.12 and 3.13

✨ 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, create a service account, generate a public-private key pair, and upload the public key to the 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 example code and SDK reference material 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.197.tar.gz (283.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

encord-0.1.197-py3-none-any.whl (361.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.197.tar.gz
  • Upload date:
  • Size: 283.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for encord-0.1.197.tar.gz
Algorithm Hash digest
SHA256 762176de257709672af1f161f863b40bb82ae3e5de4b09517f661e4b7633fe0f
MD5 964d795c1a14ee73e230e7fd4f8153dd
BLAKE2b-256 2fe763de398ff87b071758d64303bf7670226540221d36f2c15d82455153a972

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.197-py3-none-any.whl
  • Upload date:
  • Size: 361.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.16 {"installer":{"name":"uv","version":"0.9.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for encord-0.1.197-py3-none-any.whl
Algorithm Hash digest
SHA256 f8864fe43ff3bcf43df8f2818cf5b72dbfd45065b226887a394c82de603ebe05
MD5 5e706831c7d31567625cc9eda6783c33
BLAKE2b-256 dee4cb0184234b13d40cc628afd5dccddab3b94994fd09b0fe5fb83e0c6965ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page