<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` and `3.11`
## ✨ 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": "https://github.com/encord-team/encord-client-python",
"name": "encord",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "encord",
"author": "Cord Technologies Limited",
"author_email": "hello@encord.com",
"download_url": "https://files.pythonhosted.org/packages/c5/1e/60803d368a47b7975586621e7eaff0757325df4366aa32d881f24ec78179/encord-0.1.117.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` and `3.11`\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.117",
"project_urls": {
"Documentation": "https://python.docs.encord.com/",
"Homepage": "https://github.com/encord-team/encord-client-python",
"Repository": "https://github.com/encord-team/encord-client-python"
},
"split_keywords": [
"encord"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4486c87d7ea448b3c3f09dd608b2443d306823ffca5bbbb6b518062c246ee38d",
"md5": "24459e9c57c230e45abace3cd89e03f9",
"sha256": "803b642c7019f3cd1e4853bcb323d117cb004babdb1fffecd5ac906af25a8bc2"
},
"downloads": -1,
"filename": "encord-0.1.117-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24459e9c57c230e45abace3cd89e03f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 174517,
"upload_time": "2024-04-26T13:33:15",
"upload_time_iso_8601": "2024-04-26T13:33:15.285928Z",
"url": "https://files.pythonhosted.org/packages/44/86/c87d7ea448b3c3f09dd608b2443d306823ffca5bbbb6b518062c246ee38d/encord-0.1.117-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c51e60803d368a47b7975586621e7eaff0757325df4366aa32d881f24ec78179",
"md5": "d234773f31cd4445b5ee0b452ce10427",
"sha256": "1f67f17870da7d7d407df2e80c8f905573dda5704daf16513144a94ea56d1db6"
},
"downloads": -1,
"filename": "encord-0.1.117.tar.gz",
"has_sig": false,
"md5_digest": "d234773f31cd4445b5ee0b452ce10427",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 136428,
"upload_time": "2024-04-26T13:33:17",
"upload_time_iso_8601": "2024-04-26T13:33:17.731207Z",
"url": "https://files.pythonhosted.org/packages/c5/1e/60803d368a47b7975586621e7eaff0757325df4366aa32d881f24ec78179/encord-0.1.117.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-26 13:33:17",
"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"
}
JSON
