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

Uploaded Source

Built Distribution

encord-0.1.124-py3-none-any.whl (193.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: encord-0.1.124.tar.gz
  • Upload date:
  • Size: 146.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.0 CPython/3.8.18 Linux/5.15.0-1067-azure

File hashes

Hashes for encord-0.1.124.tar.gz
Algorithm Hash digest
SHA256 5c500affe8949f2f9b9aa887f0e0d0a0aa0636d95e38aa601fe8696699f948f3
MD5 724750802379d400417b9dca64d52449
BLAKE2b-256 b5358be052624ae918be9838a7a16826372ba3e6ea7c670e45fb86458d4ac0cb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.124-py3-none-any.whl
Algorithm Hash digest
SHA256 4bc553ff6faab4a4f680bc3082377f0c0cfcef94c3b407c68865d21de5137bd8
MD5 99a377b4d9f69bae7e021d92394e9491
BLAKE2b-256 06151f6ecda35cad378b888725c162c995dadaebd4affcd167b3b865ffc42d0d

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