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

Uploaded Source

Built Distribution

encord-0.1.137-py3-none-any.whl (213.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.137.tar.gz
  • Upload date:
  • Size: 167.2 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.137.tar.gz
Algorithm Hash digest
SHA256 0700c0b4dbae40d6d5218917d1e5106f71850b8957b918b5fc648354a6898718
MD5 724ca9c693e1712f8ab4b389f8ee3a4e
BLAKE2b-256 9ef5ef1a795594c238d8f21163c7b94c4ab47191a34829279844b0c521fcb91b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: encord-0.1.137-py3-none-any.whl
  • Upload date:
  • Size: 213.4 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.137-py3-none-any.whl
Algorithm Hash digest
SHA256 105ea269cd6a74a8a7b22fd80fb6b18a2a342227576e17f0a4695a7a857db6a4
MD5 208275816d9e8482658023361f5efbf8
BLAKE2b-256 31f610b867dbcc756253d957d09d9843f380014881f867d2fad1d4685493dcd6

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