# Surfer Protocol Python SDK
A Python SDK for interacting with the Surfer Protocol desktop application. Easily access and export data from various platforms like Twitter, Gmail, iMessage, and more.
## Prerequisites
The Surfer desktop application must be running in the background for the SDK to work. [Download here](https://docs.surferprotocol.org/desktop/installation).
## Installation
```bash
pip install surfer-protocol
```
## Quick Start
```python
from surfer_protocol import SurferClient
# Initialize the client
client = SurferClient()
# Get data for a specific platform
data = client.get("bookmarks-001")
# Export data for a platform
export_result = client.export("bookmarks-001")
```
## Examples
For examples of how to use the Surfer Protocol Python SDK to build applications, please see the [Cookbook](../../cookbook/python/README.md).
## Basic Usage
The SDK provides two main methods:
- `get(platform_id)`: Retrieve the most recent data for a platform
- `export(platform_id)`: Trigger a new export for a platform
## Supported Platforms
- Twitter Bookmarks (`bookmarks-001`)
- Gmail (`gmail-001`)
- iMessage (`imessage-001`)
- LinkedIn Connections (`connections-001`)
- Notion (`notion-001`)
- ChatGPT (`chatgpt-001`)
## Documentation
For complete documentation, including detailed API reference, response schemas, example applications, and best practices, visit our [official documentation](https://docs.surferprotocol.com/sdk/python).
Raw data
{
"_id": null,
"home_page": "https://github.com/Surfer-Org/Protocol/tree/main/sdk/python",
"name": "surfer-protocol",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "surfer-protocol, client, local-first, ai-agent, ai-agent-framework, langchain, langsmith, streamlit, ollama, vector-database, weaviate, personal-data, personal-data-warehouse",
"author": "Sahil Lalani",
"author_email": "lihas1002@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/25/4e/2857874c36d2f2af0d7ecbb22f4a98c2542cb0af8bf97b9e259dce766b6b/surfer_protocol-0.1.1.tar.gz",
"platform": null,
"description": "# Surfer Protocol Python SDK\n\nA Python SDK for interacting with the Surfer Protocol desktop application. Easily access and export data from various platforms like Twitter, Gmail, iMessage, and more.\n\n## Prerequisites\n\nThe Surfer desktop application must be running in the background for the SDK to work. [Download here](https://docs.surferprotocol.org/desktop/installation).\n\n## Installation\n\n```bash\npip install surfer-protocol\n```\n\n## Quick Start\n\n```python\nfrom surfer_protocol import SurferClient\n\n# Initialize the client\nclient = SurferClient()\n\n# Get data for a specific platform\ndata = client.get(\"bookmarks-001\")\n\n# Export data for a platform\nexport_result = client.export(\"bookmarks-001\")\n```\n\n## Examples\n\nFor examples of how to use the Surfer Protocol Python SDK to build applications, please see the [Cookbook](../../cookbook/python/README.md).\n\n## Basic Usage\n\nThe SDK provides two main methods:\n- `get(platform_id)`: Retrieve the most recent data for a platform\n- `export(platform_id)`: Trigger a new export for a platform\n\n## Supported Platforms\n\n- Twitter Bookmarks (`bookmarks-001`)\n- Gmail (`gmail-001`)\n- iMessage (`imessage-001`)\n- LinkedIn Connections (`connections-001`)\n- Notion (`notion-001`)\n- ChatGPT (`chatgpt-001`)\n\n## Documentation\n\nFor complete documentation, including detailed API reference, response schemas, example applications, and best practices, visit our [official documentation](https://docs.surferprotocol.com/sdk/python).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for the Surfer Protocol desktop app",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/Surfer-Org/Protocol/tree/main/sdk/python"
},
"split_keywords": [
"surfer-protocol",
" client",
" local-first",
" ai-agent",
" ai-agent-framework",
" langchain",
" langsmith",
" streamlit",
" ollama",
" vector-database",
" weaviate",
" personal-data",
" personal-data-warehouse"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "29918ce75bdffa422cae2a6166ecd5ae8fc8d8dc156a992a050d866f3790671e",
"md5": "43b5f4dab262a820cfa40aa14af2ce2e",
"sha256": "01d6b7cac25e89766f166fea70eca13c16121653bf6f9fd0e4e73c1b81f25d18"
},
"downloads": -1,
"filename": "surfer_protocol-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43b5f4dab262a820cfa40aa14af2ce2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4050,
"upload_time": "2024-12-11T22:22:37",
"upload_time_iso_8601": "2024-12-11T22:22:37.911402Z",
"url": "https://files.pythonhosted.org/packages/29/91/8ce75bdffa422cae2a6166ecd5ae8fc8d8dc156a992a050d866f3790671e/surfer_protocol-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "254e2857874c36d2f2af0d7ecbb22f4a98c2542cb0af8bf97b9e259dce766b6b",
"md5": "5a9e4868e02d043f186212ea270c70e6",
"sha256": "8a4f5bc0ed97d66085257ae801e9689e1e4a5ae08153111e684e518f95ae6920"
},
"downloads": -1,
"filename": "surfer_protocol-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5a9e4868e02d043f186212ea270c70e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3805,
"upload_time": "2024-12-11T22:22:40",
"upload_time_iso_8601": "2024-12-11T22:22:40.071793Z",
"url": "https://files.pythonhosted.org/packages/25/4e/2857874c36d2f2af0d7ecbb22f4a98c2542cb0af8bf97b9e259dce766b6b/surfer_protocol-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-11 22:22:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Surfer-Org",
"github_project": "Protocol",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "surfer-protocol"
}
JSON
