| Name | encord JSON |
| Version |
0.1.173
JSON |
| download |
| home_page | None |
| Summary | Encord Python SDK Client |
| upload_time | 2025-08-07 12:43:43 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache Software License |
| keywords |
encord
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">
<p align="center">Encord Python API Client</p>
<a href="https://encord.com">
<img src="https://storage.googleapis.com/docs-media.encord.com/encord.png" width="280" alt="Encord logo"/>
</a>
</h1>
[](https://opensource.org/licenses/Apache-2.0)
# 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`, `3.11`, `3.12` and `3.13`
## ✨ Relevant Links
* [Encord website](https://encord.com)
* [Encord web app](https://app.encord.com)
* [Encord documentation](https://docs.encord.com)
## 💡 Getting Started
For full documentation, please visit [Encord Python SDK](https://docs.encord.com/reference/installation-sdk).
First, install Encord Python API Client using the [pip](https://pip.pypa.io/en/stable/installing) package manager:
```bash
python3 -m pip install encord
```
Then, generate an public-private key pair, and upload the public key to [Encord website](https://www.encord.com/).
Detailed guide can be found in the [dedicated manual](https://docs.encord.com/docs/annotate-public-keys).
Passing the private key to the factory, you can initialise the Encord client directly.
```python
# 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](https://python.docs.encord.com/)
## 🐛 Troubleshooting
Please report bugs to the [GitHub Issues](https://github.com/encord-team/encord-client-python/issues).
Just make sure you read the [Encord documentation](https://docs.encord.com) and search for related issues first.
Raw data
{
"_id": null,
"home_page": null,
"name": "encord",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "encord",
"author": null,
"author_email": "Cord Technologies Limited <hello@encord.com>",
"download_url": "https://files.pythonhosted.org/packages/93/c8/23c2b85581315512a791fdd6aec2ef5831467004afc489fe7f848f5cf6ab/encord-0.1.173.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <p align=\"center\">Encord Python API Client</p>\n <a href=\"https://encord.com\">\n <img src=\"https://storage.googleapis.com/docs-media.encord.com/encord.png\" width=\"280\" alt=\"Encord logo\"/>\n </a>\n</h1>\n\n[](https://opensource.org/licenses/Apache-2.0)\n\n# The data engine for computer vision\n\n## \ud83d\udcbb Features\n\n- Minimal low-level Python client that allows you to interact with Encord's API\n- Supports Python: `3.8`, `3.9`, `3.10`, `3.11`, `3.12` and `3.13`\n\n## \u2728 Relevant Links\n\n* [Encord website](https://encord.com)\n* [Encord web app](https://app.encord.com)\n* [Encord documentation](https://docs.encord.com)\n\n## \ud83d\udca1 Getting Started\n\nFor full documentation, please visit [Encord Python SDK](https://docs.encord.com/reference/installation-sdk).\n\nFirst, install Encord Python API Client using the [pip](https://pip.pypa.io/en/stable/installing) package manager:\n\n```bash\npython3 -m pip install encord\n```\n\nThen, generate an public-private key pair, and upload the public key to [Encord website](https://www.encord.com/).\nDetailed guide can be found in the [dedicated manual](https://docs.encord.com/docs/annotate-public-keys).\n\nPassing the private key to the factory, you can initialise the Encord client directly.\n\n```python\n# Import dependencies\nfrom encord import EncordUserClient\n\n# Authenticate with Encord using the path to your private key. Replace <private_key_path> with the path to your private key.\nuser_client = EncordUserClient.create_with_ssh_private_key(\n ssh_private_key_path=\"<private_key_path>\"\n )\n```\n\nFor detailed examples and API reference please refer to [Encord SDK documentation](https://python.docs.encord.com/)\n\n## \ud83d\udc1b Troubleshooting\n\nPlease report bugs to the [GitHub Issues](https://github.com/encord-team/encord-client-python/issues).\nJust make sure you read the [Encord documentation](https://docs.encord.com) and search for related issues first.\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Encord Python SDK Client",
"version": "0.1.173",
"project_urls": {
"documentation": "https://python.docs.encord.com/",
"repository": "https://github.com/encord-team/encord-client-python"
},
"split_keywords": [
"encord"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "13d0f9e2e27918966bedb408b34845ba7f90d2af40d8a39f514c1140119f5770",
"md5": "d3d18d9041fc11f40eb7c0252f6c6d1d",
"sha256": "942ecd56882d2a5f004169118b122aaf4960f0d2c371b0b3bbe2be930af07751"
},
"downloads": -1,
"filename": "encord-0.1.173-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3d18d9041fc11f40eb7c0252f6c6d1d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 256620,
"upload_time": "2025-08-07T12:43:42",
"upload_time_iso_8601": "2025-08-07T12:43:42.341198Z",
"url": "https://files.pythonhosted.org/packages/13/d0/f9e2e27918966bedb408b34845ba7f90d2af40d8a39f514c1140119f5770/encord-0.1.173-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "93c823c2b85581315512a791fdd6aec2ef5831467004afc489fe7f848f5cf6ab",
"md5": "a766a6f8228e876c6015c91423a6919d",
"sha256": "efcdd80073e79fb24393f580700d51f81f4759b0dab4af190f832d86bb1cd1d9"
},
"downloads": -1,
"filename": "encord-0.1.173.tar.gz",
"has_sig": false,
"md5_digest": "a766a6f8228e876c6015c91423a6919d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 611919,
"upload_time": "2025-08-07T12:43:43",
"upload_time_iso_8601": "2025-08-07T12:43:43.596472Z",
"url": "https://files.pythonhosted.org/packages/93/c8/23c2b85581315512a791fdd6aec2ef5831467004afc489fe7f848f5cf6ab/encord-0.1.173.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-07 12:43:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "encord-team",
"github_project": "encord-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "encord"
}
