| Name | roolink-sdk JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | A Python SDK for interacting with the RooLink API |
| upload_time | 2024-12-17 16:21:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.6 |
| license | The MIT License (MIT) Copyright (c) 2024 RooLinkIO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sdk
roolink
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# RooLink SDK
RooLink SDK is a Python library designed for seamless interaction with the RooLink API. It provides utilities for API request limits, parsing scripts, generating sensor data, and more.
## Features
- Fetch API request limits
- Parse script data
- Generate sensor data for validation
- Create SBSD body
- Generate pixel data
- Solve sec-cpt challenges
## Usage
Install the SDK via pip:
```bash
pip install roolink-sdk
```
Quick Start
Here's how to use the SDK in your Python project:
### Import the SDK and Initialize
```python
from roolink_sdk.client import RooLink
from roolink_sdk.utils import get_bazadebezolkohpepadr, parse_script_url
# Initialize the RooLink SDK
api_key = "your_api_key"
protected_url = "https://example.com"
user_agent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"
session = RooLink(api_key, protected_url, user_agent)
```
### Fetch API Request Limit
```python
limit = session.request_limit()
print("Request Limit:", limit)
```
### Parse Script Data
```python
script_body = "function example() { return 'sample'; }"
parsed_data = session.parse_script_data(script_body)
print("Parsed Data:", parsed_data)
```
### Generate Sensor Data
```python
abck = "sample_abck"
bm_sz = "sample_bm_sz"
sensor_data = session.generate_sensor_data(abck, bm_sz)
print("Sensor Data:", sensor_data)
```
### Generate SBSD Body
```python
vid = "sample_vid"
cookie = "sample_cookie"
sbsd_body = session.generate_sbsd_body(vid, cookie)
print("SBSD Body:", sbsd_body)
```
### Generate Pixel Data
```python
bazadebezolkohpepadr = 12345
hash_value = "sample_hash"
pixel_data = session.generate_pixel_data(bazadebezolkohpepadr, hash_value)
print("Pixel Data:", pixel_data)
```
### Solve sec-cpt Challenges
```python
token = "sample_token"
timestamp = 1234567890
nonce = "sample_nonce"
difficulty = 3
cookie = "sample_cookie"
sec_cpt_answers = session.generate_sec_cpt_answers(token, timestamp, nonce, difficulty, cookie)
print("Sec-CPT Answers:", sec_cpt_answers)
```
## License
```markdown
This project is licensed under the MIT License. See the LICENSE file for details.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "roolink-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "SDK, RooLink, API",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/85/f5/6fa2fe092e56675a2d11eb07cd7cd178a329a4253819c694078f88848f49/roolink_sdk-1.0.0.tar.gz",
"platform": null,
"description": "# RooLink SDK\r\n\r\nRooLink SDK is a Python library designed for seamless interaction with the RooLink API. It provides utilities for API request limits, parsing scripts, generating sensor data, and more.\r\n\r\n## Features\r\n\r\n- Fetch API request limits\r\n- Parse script data\r\n- Generate sensor data for validation\r\n- Create SBSD body\r\n- Generate pixel data\r\n- Solve sec-cpt challenges\r\n\r\n## Usage\r\n\r\nInstall the SDK via pip:\r\n\r\n```bash\r\npip install roolink-sdk\r\n```\r\nQuick Start\r\nHere's how to use the SDK in your Python project:\r\n\r\n### Import the SDK and Initialize\r\n```python\r\nfrom roolink_sdk.client import RooLink\r\nfrom roolink_sdk.utils import get_bazadebezolkohpepadr, parse_script_url\r\n\r\n# Initialize the RooLink SDK\r\napi_key = \"your_api_key\"\r\nprotected_url = \"https://example.com\"\r\nuser_agent = \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36\"\r\n\r\nsession = RooLink(api_key, protected_url, user_agent)\r\n```\r\n### Fetch API Request Limit\r\n```python\r\nlimit = session.request_limit()\r\nprint(\"Request Limit:\", limit)\r\n```\r\n### Parse Script Data\r\n```python\r\nscript_body = \"function example() { return 'sample'; }\"\r\nparsed_data = session.parse_script_data(script_body)\r\nprint(\"Parsed Data:\", parsed_data)\r\n```\r\n### Generate Sensor Data\r\n```python\r\nabck = \"sample_abck\"\r\nbm_sz = \"sample_bm_sz\"\r\nsensor_data = session.generate_sensor_data(abck, bm_sz)\r\nprint(\"Sensor Data:\", sensor_data)\r\n```\r\n### Generate SBSD Body\r\n```python\r\nvid = \"sample_vid\"\r\ncookie = \"sample_cookie\"\r\nsbsd_body = session.generate_sbsd_body(vid, cookie)\r\nprint(\"SBSD Body:\", sbsd_body)\r\n```\r\n### Generate Pixel Data\r\n```python\r\nbazadebezolkohpepadr = 12345\r\nhash_value = \"sample_hash\"\r\npixel_data = session.generate_pixel_data(bazadebezolkohpepadr, hash_value)\r\nprint(\"Pixel Data:\", pixel_data)\r\n```\r\n### Solve sec-cpt Challenges\r\n```python\r\ntoken = \"sample_token\"\r\ntimestamp = 1234567890\r\nnonce = \"sample_nonce\"\r\ndifficulty = 3\r\ncookie = \"sample_cookie\"\r\nsec_cpt_answers = session.generate_sec_cpt_answers(token, timestamp, nonce, difficulty, cookie)\r\nprint(\"Sec-CPT Answers:\", sec_cpt_answers)\r\n```\r\n\r\n## License\r\n```markdown\r\nThis project is licensed under the MIT License. See the LICENSE file for details.\r\n```\r\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) Copyright (c) 2024 RooLinkIO Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A Python SDK for interacting with the RooLink API",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/RooLinkIO/roolink-sdk-py",
"Repository": "https://github.com/RooLinkIO/roolink-sdk-py"
},
"split_keywords": [
"sdk",
" roolink",
" api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0928b02b2b2b49596390bed4181d4fe2d7da462a4988636f952e89050abaf82f",
"md5": "cd2af2c5f6d9d76cc8bc118e86151f04",
"sha256": "fbe73bb9659c75db30076e4d8c98fca5ddfc67c3fd62beba0172d378d342e27d"
},
"downloads": -1,
"filename": "roolink_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd2af2c5f6d9d76cc8bc118e86151f04",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6375,
"upload_time": "2024-12-17T16:21:46",
"upload_time_iso_8601": "2024-12-17T16:21:46.802849Z",
"url": "https://files.pythonhosted.org/packages/09/28/b02b2b2b49596390bed4181d4fe2d7da462a4988636f952e89050abaf82f/roolink_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85f56fa2fe092e56675a2d11eb07cd7cd178a329a4253819c694078f88848f49",
"md5": "ef06a15b3a1a319f7200ddfd70ef27f9",
"sha256": "9648308314b52d9fbe0d38e6d23c9e8d537712f0a4ec903b494dfaacd3926ab8"
},
"downloads": -1,
"filename": "roolink_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ef06a15b3a1a319f7200ddfd70ef27f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5097,
"upload_time": "2024-12-17T16:21:49",
"upload_time_iso_8601": "2024-12-17T16:21:49.236479Z",
"url": "https://files.pythonhosted.org/packages/85/f5/6fa2fe092e56675a2d11eb07cd7cd178a329a4253819c694078f88848f49/roolink_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 16:21:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RooLinkIO",
"github_project": "roolink-sdk-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "roolink-sdk"
}
