| Name | rss3-dsl-client JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A Python SDK for RSS3 Data Sub Layer (DSL) |
| upload_time | 2024-06-07 14:48:10 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.9 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rss3-dsl-client
A Python SDK for interacting with the RSS3 Data Sub Layer (DSL) API.
## Installation
To install `rss3-dsl-client`, you can use [Poetry](https://python-poetry.org/). First, ensure you have Poetry installed, then run:
```sh
pip install rss3-dsl-client
```
This will add `rss3-dsl-client` to your project's dependencies.
## Usage
Here's a simple example of how to use the `rss3-dsl-client` to interact with the RSS3 DSL API.
### Initialize the Client
First, you need to initialize the client with the base URL of the API. You can use different URLs for development and production environments.
#### Production Environment
```python
from rss3_dsl_client.client import Client
# Initialize the client with the production base URL of the API
client = Client(base_url="https://gi.rss3.io")
```
#### Development Environment
```python
from rss3_dsl_client.client import Client
# Initialize the client with the development base URL of the API
client = Client(base_url="https://gi.rss3.dev")
```
### Get Activity Details by Transaction ID
You can retrieve activity details by providing a transaction ID.
```python
# Get activity details by transaction ID
activity = client.get_activity_by_id("0x000000000000000000000000113f4b4c3765e5f05fd197c5c35b8a8a9b34245b")
print(activity)
```
### Get Account Activities
Retrieve a list of activities for a specific account. You can also specify various parameters to filter the results.
```python
# Get account activities with minimal parameters
activities = client.get_account_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
limit=10
)
print(activities)
```
### Get Account Activities with Filters
You can also retrieve activities for a specific account with additional filters.
```python
# Get account activities with network filter
activities = client.get_account_activities(
account="vitalik.eth",
network=["ethereum", "polygon"]
)
print(activities)
# Get account activities with platform filter
activities = client.get_account_activities(
account="vitalik.eth",
platform=["OpenSea", "Uniswap"]
)
print(activities)
# Get account activities with tag filter
activities = client.get_account_activities(
account="vitalik.eth",
tag=["collectible", "exchange"]
)
print(activities)
# Get account activities with multiple filters
activities = client.get_account_activities(
account="vitalik.eth",
network=["farcaster"],
platform=["Farcaster"],
tag=["social"],
limit=50,
action_limit=5
)
print(activities)
```
### Get RSS Activity by Path
Retrieve RSS activity details by providing a specific path.
```python
# Get RSS activity by path
rss_activity = client.get_rss_activity_by_path("abc")
print(rss_activity)
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "rss3-dsl-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "your.email@example.com",
"download_url": "https://files.pythonhosted.org/packages/d5/88/4637bdfc8ba28c79d521668f6d0f76f29822781512f5299bb363ca0fe88d/rss3_dsl_client-0.1.0.tar.gz",
"platform": null,
"description": "# rss3-dsl-client\n\nA Python SDK for interacting with the RSS3 Data Sub Layer (DSL) API.\n\n## Installation\n\nTo install `rss3-dsl-client`, you can use [Poetry](https://python-poetry.org/). First, ensure you have Poetry installed, then run:\n\n```sh\npip install rss3-dsl-client\n```\n\nThis will add `rss3-dsl-client` to your project's dependencies.\n\n## Usage\n\nHere's a simple example of how to use the `rss3-dsl-client` to interact with the RSS3 DSL API.\n\n### Initialize the Client\n\nFirst, you need to initialize the client with the base URL of the API. You can use different URLs for development and production environments.\n\n#### Production Environment\n\n```python\nfrom rss3_dsl_client.client import Client\n\n# Initialize the client with the production base URL of the API\nclient = Client(base_url=\"https://gi.rss3.io\")\n```\n\n#### Development Environment\n\n```python\nfrom rss3_dsl_client.client import Client\n\n# Initialize the client with the development base URL of the API\nclient = Client(base_url=\"https://gi.rss3.dev\")\n```\n\n### Get Activity Details by Transaction ID\n\nYou can retrieve activity details by providing a transaction ID.\n\n```python\n# Get activity details by transaction ID\nactivity = client.get_activity_by_id(\"0x000000000000000000000000113f4b4c3765e5f05fd197c5c35b8a8a9b34245b\")\nprint(activity)\n```\n\n### Get Account Activities\n\nRetrieve a list of activities for a specific account. You can also specify various parameters to filter the results.\n\n```python\n# Get account activities with minimal parameters\nactivities = client.get_account_activities(\n account=\"0xd8da6bf26964af9d7eed9e03e53415d37aa96045\",\n limit=10\n)\nprint(activities)\n```\n\n### Get Account Activities with Filters\n\nYou can also retrieve activities for a specific account with additional filters.\n\n```python\n# Get account activities with network filter\nactivities = client.get_account_activities(\n account=\"vitalik.eth\",\n network=[\"ethereum\", \"polygon\"]\n)\nprint(activities)\n\n# Get account activities with platform filter\nactivities = client.get_account_activities(\n account=\"vitalik.eth\",\n platform=[\"OpenSea\", \"Uniswap\"]\n)\nprint(activities)\n\n# Get account activities with tag filter\nactivities = client.get_account_activities(\n account=\"vitalik.eth\",\n tag=[\"collectible\", \"exchange\"]\n)\nprint(activities)\n\n# Get account activities with multiple filters\nactivities = client.get_account_activities(\n account=\"vitalik.eth\",\n network=[\"farcaster\"],\n platform=[\"Farcaster\"],\n tag=[\"social\"],\n limit=50,\n action_limit=5\n)\nprint(activities)\n```\n\n### Get RSS Activity by Path\n\nRetrieve RSS activity details by providing a specific path.\n\n```python\n# Get RSS activity by path\nrss_activity = client.get_rss_activity_by_path(\"abc\")\nprint(rss_activity)\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python SDK for RSS3 Data Sub Layer (DSL)",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9693af5f5d0c8afe524075f8f8e9ee764b4b0fe9856dbbd38b6b0f3f4b2ef294",
"md5": "76d3235ad1803b38c8a2aacab48d2bbe",
"sha256": "ec199939cfb7ead524def3fab6786643cd2395d8f836f830f39a51e7485c9ce1"
},
"downloads": -1,
"filename": "rss3_dsl_client-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76d3235ad1803b38c8a2aacab48d2bbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 4467,
"upload_time": "2024-06-07T14:48:08",
"upload_time_iso_8601": "2024-06-07T14:48:08.200471Z",
"url": "https://files.pythonhosted.org/packages/96/93/af5f5d0c8afe524075f8f8e9ee764b4b0fe9856dbbd38b6b0f3f4b2ef294/rss3_dsl_client-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5884637bdfc8ba28c79d521668f6d0f76f29822781512f5299bb363ca0fe88d",
"md5": "4ec3d26e28c5f3099aa8054139296c01",
"sha256": "26befe6a57f5d13fa01b7a09f1ba1086674315e6303caa1404b610a612297a09"
},
"downloads": -1,
"filename": "rss3_dsl_client-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4ec3d26e28c5f3099aa8054139296c01",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 3731,
"upload_time": "2024-06-07T14:48:10",
"upload_time_iso_8601": "2024-06-07T14:48:10.585708Z",
"url": "https://files.pythonhosted.org/packages/d5/88/4637bdfc8ba28c79d521668f6d0f76f29822781512f5299bb363ca0fe88d/rss3_dsl_client-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 14:48:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rss3-dsl-client"
}
