| Name | rss3-dsl-sdk JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | A Python SDK for RSS3 Data Sub Layer (DSL) |
| upload_time | 2024-07-22 12:14:58 |
| 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 SDK 📡
A client for interacting with the RSS3 Data Sub Layer (DSL) API.
## Features ✨
- Fetch various types of activities for an account including collectibles, exchanges, metaverse, social, and transactions.
- Supports pagination and filtering for activity retrieval.
- Retrieve RSS activity details by path.
## Installation 🚀
You can install the required dependencies using pip:
```bash
pip install rss3-dsl-sdk
```
## Usage 📘
### Initialize the Client
```python
from rss3_dsl_sdk import RSS3Client
client = RSS3Client()
```
### Fetch Social Post Activities
Here are some examples of fetching social post activities with different parameters:
```python
from rss3_dsl_sdk.schemas.common import PaginationOptions, ActivityFilter
from rss3_dsl_sdk.schemas.enums import Platform
# Example 1: Basic usage with pagination
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
# Example 2: Using filters for platform
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
filters=ActivityFilter(platform=[Platform.FARCASTER, Platform.LENS]),
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
# Example 3: Using filters with time range
social_post_activities = client.fetch_social_post_activities(
account="0xd8da6bf26964af9d7eed9e03e53415d37aa96045",
filters=ActivityFilter(since_timestamp=1625097600, until_timestamp=1627689600),
pagination=PaginationOptions(limit=10)
)
print(social_post_activities)
```
### Fetch RSS Activity by Path
You can also fetch RSS activity details by path using the `fetch_rss_activity_by_path` method:
```python
rss_activity = client.fetch_rss_activity_by_path(path="abc")
print(rss_activity)
```
### Other Available Methods
The `RSS3Client` class provides various methods to fetch different types of activities. Below are the available methods:
- `fetch_collectible_approval_activities`
- `fetch_collectible_burn_activities`
- `fetch_collectible_mint_activities`
- `fetch_collectible_trade_activities`
- `fetch_collectible_transfer_activities`
- `fetch_exchange_liquidity_activities`
- `fetch_exchange_staking_activities`
- `fetch_exchange_swap_activities`
- `fetch_metaverse_burn_activities`
- `fetch_metaverse_mint_activities`
- `fetch_metaverse_trade_activities`
- `fetch_metaverse_transfer_activities`
- `fetch_social_comment_activities`
- `fetch_social_delete_activities`
- `fetch_social_mint_activities`
- `fetch_social_profile_activities`
- `fetch_social_proxy_activities`
- `fetch_social_revise_activities`
- `fetch_social_reward_activities`
- `fetch_social_share_activities`
- `fetch_transaction_approval_activities`
- `fetch_transaction_bridge_activities`
- `fetch_transaction_burn_activities`
- `fetch_transaction_mint_activities`
- `fetch_transaction_transfer_activities`
## Contributing 🤝
Contributions are welcome! Please open an issue or submit a pull request.
## 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-sdk",
"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/b0/ad/dd7c5efafdda766866b0bc87128f2e53de20e409da738ffae3578c5a2642/rss3_dsl_sdk-0.4.0.tar.gz",
"platform": null,
"description": "# RSS3 DSL SDK \ud83d\udce1\n\nA client for interacting with the RSS3 Data Sub Layer (DSL) API.\n\n## Features \u2728\n\n- Fetch various types of activities for an account including collectibles, exchanges, metaverse, social, and transactions.\n- Supports pagination and filtering for activity retrieval.\n- Retrieve RSS activity details by path.\n\n## Installation \ud83d\ude80\n\nYou can install the required dependencies using pip:\n\n```bash\npip install rss3-dsl-sdk\n```\n\n## Usage \ud83d\udcd8\n\n### Initialize the Client\n\n```python\nfrom rss3_dsl_sdk import RSS3Client\n\nclient = RSS3Client()\n```\n\n### Fetch Social Post Activities\n\nHere are some examples of fetching social post activities with different parameters:\n\n```python\nfrom rss3_dsl_sdk.schemas.common import PaginationOptions, ActivityFilter\nfrom rss3_dsl_sdk.schemas.enums import Platform\n\n# Example 1: Basic usage with pagination\nsocial_post_activities = client.fetch_social_post_activities(\n account=\"0xd8da6bf26964af9d7eed9e03e53415d37aa96045\",\n pagination=PaginationOptions(limit=10)\n)\nprint(social_post_activities)\n\n# Example 2: Using filters for platform\nsocial_post_activities = client.fetch_social_post_activities(\n account=\"0xd8da6bf26964af9d7eed9e03e53415d37aa96045\",\n filters=ActivityFilter(platform=[Platform.FARCASTER, Platform.LENS]),\n pagination=PaginationOptions(limit=10)\n)\nprint(social_post_activities)\n\n# Example 3: Using filters with time range\nsocial_post_activities = client.fetch_social_post_activities(\n account=\"0xd8da6bf26964af9d7eed9e03e53415d37aa96045\",\n filters=ActivityFilter(since_timestamp=1625097600, until_timestamp=1627689600),\n pagination=PaginationOptions(limit=10)\n)\nprint(social_post_activities)\n```\n\n### Fetch RSS Activity by Path\n\nYou can also fetch RSS activity details by path using the `fetch_rss_activity_by_path` method:\n\n```python\nrss_activity = client.fetch_rss_activity_by_path(path=\"abc\")\nprint(rss_activity)\n```\n\n### Other Available Methods\n\nThe `RSS3Client` class provides various methods to fetch different types of activities. Below are the available methods:\n\n- `fetch_collectible_approval_activities`\n- `fetch_collectible_burn_activities`\n- `fetch_collectible_mint_activities`\n- `fetch_collectible_trade_activities`\n- `fetch_collectible_transfer_activities`\n- `fetch_exchange_liquidity_activities`\n- `fetch_exchange_staking_activities`\n- `fetch_exchange_swap_activities`\n- `fetch_metaverse_burn_activities`\n- `fetch_metaverse_mint_activities`\n- `fetch_metaverse_trade_activities`\n- `fetch_metaverse_transfer_activities`\n- `fetch_social_comment_activities`\n- `fetch_social_delete_activities`\n- `fetch_social_mint_activities`\n- `fetch_social_profile_activities`\n- `fetch_social_proxy_activities`\n- `fetch_social_revise_activities`\n- `fetch_social_reward_activities`\n- `fetch_social_share_activities`\n- `fetch_transaction_approval_activities`\n- `fetch_transaction_bridge_activities`\n- `fetch_transaction_burn_activities`\n- `fetch_transaction_mint_activities`\n- `fetch_transaction_transfer_activities`\n\n## Contributing \ud83e\udd1d\n\nContributions are welcome! Please open an issue or submit a pull request.\n\n## License \ud83d\udcc4\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.4.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "41a85a188d4e9e4bde2fd19e7fdf3f26d06399aad6edfe8c27b10fb9f7394b7c",
"md5": "bfcff5d0239be8bb1dd741ba5f6b1625",
"sha256": "36b27065339673266c6ea0731b6e488063b547d24a0b835e0add0bb10c44ff3a"
},
"downloads": -1,
"filename": "rss3_dsl_sdk-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bfcff5d0239be8bb1dd741ba5f6b1625",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 9970,
"upload_time": "2024-07-22T12:14:57",
"upload_time_iso_8601": "2024-07-22T12:14:57.999845Z",
"url": "https://files.pythonhosted.org/packages/41/a8/5a188d4e9e4bde2fd19e7fdf3f26d06399aad6edfe8c27b10fb9f7394b7c/rss3_dsl_sdk-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0addd7c5efafdda766866b0bc87128f2e53de20e409da738ffae3578c5a2642",
"md5": "dfe82a18b3de1cf1ab5b4a17934daa21",
"sha256": "8716ead998c8ac357cb45f88d158249b1ef5530d842edcf2d81cf97a80250a2f"
},
"downloads": -1,
"filename": "rss3_dsl_sdk-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "dfe82a18b3de1cf1ab5b4a17934daa21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 7855,
"upload_time": "2024-07-22T12:14:58",
"upload_time_iso_8601": "2024-07-22T12:14:58.928212Z",
"url": "https://files.pythonhosted.org/packages/b0/ad/dd7c5efafdda766866b0bc87128f2e53de20e409da738ffae3578c5a2642/rss3_dsl_sdk-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-22 12:14:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "rss3-dsl-sdk"
}
