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

Uploaded Source

Built Distribution

encord-0.1.115-py3-none-any.whl (170.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.115.tar.gz
Algorithm Hash digest
SHA256 1e7bfacdefaddd32f580c05261f709212e7f78b99a257b6671e755bacd121f8c
MD5 376cf1104dceb0ff699e097d9d212b70
BLAKE2b-256 cc84b0cea4511eacd6e3db2b33e5226ad77f7fa95792f80b0f1a958519794415

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for encord-0.1.115-py3-none-any.whl
Algorithm Hash digest
SHA256 6a00fbb891b297649f2a76c4115561421d90ee3c382f1552bbff8889b338c5e1
MD5 cb5be576d8307fe292b0931453a8cfe8
BLAKE2b-256 2837ddd85cafd6b77fd2682472b5de83b351c9310ca08746e565233c3a836af5

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