| Name | boosty JSON |
| Version |
0.0.20
JSON |
| download |
| home_page | None |
| Summary | Asynchronous boosty wrapper with some utils |
| upload_time | 2024-05-13 20:32:08 |
| maintainer | None |
| docs_url | None |
| author | barsikus007 |
| requires_python | >=3.10 |
| license | None |
| keywords |
asyncio
boosty
wrapper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://github.com/barsikus007/boosty">
<img src="https://raw.githubusercontent.com/barsikus007/boosty/master/logo.png" alt="BoostyPy">
</a>
</p>
# Boosty Wrapper
[](https://pypi.org/project/boosty)
[](https://pypi.org/project/boosty)
[](https://github.com/pypa/hatch)
-----
**Table of Contents**
- [Installation](#installation)
- [License](#license)
- [Usage](#usage)
## Installation
```console
pip install boosty
```
## License
`boosty` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
> [!IMPORTANT]
> **!WARNING! this version of library is very unstable**
>
> **If you use it, contact maintainer to help make it stable**
## Usage
*Optional:* specify `IGNORE_MISSING_AND_EXTRA_FIELDS` environment variable to disable strict schema validation
*Optional:* fill `auth.json` file with authentication data:
```json
{
"access_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"device_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"expires_at": 12345678900,
"refresh_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}
```
Example:
```python
from boosty.api import API
api = API()
response = await api.get_post("boosty", post_id="c9fb8a19-c45e-4602-9942-087c3af28c1b")
print(response.title)
# 'Добро пожаловать на борт!'
```
More examples in [examples/](https://github.com/barsikus007/boosty/blob/master/examples/) folder
### TODO for stable release
- api schema
- add access levels logic for requests
- minimal docs
- useful properties for models
- merge reply comment with comment model
- add examples
- render text
- get video url
- get comment url
- add tests
- boosty profile
- comments
- replies
- video
- entities parsing
Raw data
{
"_id": null,
"home_page": null,
"name": "boosty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "asyncio, boosty, wrapper",
"author": "barsikus007",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3d/24/1fdb64e8fc1a7496801b55e39976672ae8f173444e16f7aea6eb0d7a72a2/boosty-0.0.20.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/barsikus007/boosty\">\n <img src=\"https://raw.githubusercontent.com/barsikus007/boosty/master/logo.png\" alt=\"BoostyPy\">\n </a>\n</p>\n\n# Boosty Wrapper\n\n[](https://pypi.org/project/boosty)\n[](https://pypi.org/project/boosty)\n[](https://github.com/pypa/hatch)\n\n-----\n\n**Table of Contents**\n\n- [Installation](#installation)\n- [License](#license)\n- [Usage](#usage)\n\n## Installation\n\n```console\npip install boosty\n```\n\n## License\n\n`boosty` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n\n> [!IMPORTANT]\n> **!WARNING! this version of library is very unstable**\n>\n> **If you use it, contact maintainer to help make it stable**\n\n## Usage\n\n*Optional:* specify `IGNORE_MISSING_AND_EXTRA_FIELDS` environment variable to disable strict schema validation\n\n*Optional:* fill `auth.json` file with authentication data:\n\n```json\n{\n \"access_token\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\",\n \"device_id\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"expires_at\": 12345678900,\n \"refresh_token\": \"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\"\n}\n```\n\nExample:\n\n```python\nfrom boosty.api import API\n\napi = API()\nresponse = await api.get_post(\"boosty\", post_id=\"c9fb8a19-c45e-4602-9942-087c3af28c1b\")\nprint(response.title)\n# '\u0414\u043e\u0431\u0440\u043e \u043f\u043e\u0436\u0430\u043b\u043e\u0432\u0430\u0442\u044c \u043d\u0430 \u0431\u043e\u0440\u0442!'\n```\n\nMore examples in [examples/](https://github.com/barsikus007/boosty/blob/master/examples/) folder\n\n### TODO for stable release\n\n- api schema\n - add access levels logic for requests\n- minimal docs\n- useful properties for models\n- merge reply comment with comment model\n- add examples\n - render text\n - get video url\n - get comment url\n- add tests\n - boosty profile\n - comments\n - replies\n - video\n - entities parsing\n",
"bugtrack_url": null,
"license": null,
"summary": "Asynchronous boosty wrapper with some utils",
"version": "0.0.20",
"project_urls": {
"Documentation": "https://github.com/barsikus007/boosty#readme",
"Issues": "https://github.com/barsikus007/boosty/issues",
"Source": "https://github.com/barsikus007/boosty"
},
"split_keywords": [
"asyncio",
" boosty",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a9fd77b285d204568622b93ebe5b20e1a7551b181f1e0d1dd2f285780d3ee844",
"md5": "689cad4322cc6a72da4309447e16f85a",
"sha256": "5b7cc54e8f611839d0cbba78ba25c74262e7542401afc696d8505bbc7397eb37"
},
"downloads": -1,
"filename": "boosty-0.0.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "689cad4322cc6a72da4309447e16f85a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 19068,
"upload_time": "2024-05-13T20:32:06",
"upload_time_iso_8601": "2024-05-13T20:32:06.368538Z",
"url": "https://files.pythonhosted.org/packages/a9/fd/77b285d204568622b93ebe5b20e1a7551b181f1e0d1dd2f285780d3ee844/boosty-0.0.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3d241fdb64e8fc1a7496801b55e39976672ae8f173444e16f7aea6eb0d7a72a2",
"md5": "7919c2cd835b292106c1a89d417a38e2",
"sha256": "e7f6de69c40a6ad733328ff80af152b7f794b61b81130e808109bed42d7259e0"
},
"downloads": -1,
"filename": "boosty-0.0.20.tar.gz",
"has_sig": false,
"md5_digest": "7919c2cd835b292106c1a89d417a38e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 39310,
"upload_time": "2024-05-13T20:32:08",
"upload_time_iso_8601": "2024-05-13T20:32:08.622105Z",
"url": "https://files.pythonhosted.org/packages/3d/24/1fdb64e8fc1a7496801b55e39976672ae8f173444e16f7aea6eb0d7a72a2/boosty-0.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-13 20:32:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barsikus007",
"github_project": "boosty#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "boosty"
}
