| Name | boosty JSON |
| Version |
0.0.29
JSON |
| download |
| home_page | None |
| Summary | Asynchronous boosty wrapper with some utils |
| upload_time | 2024-10-02 12:39:52 |
| 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.svg" alt="BoostyPy" height="250px">
</a>
</p>
# Boosty Wrapper
[](https://pypi.org/project/boosty)
[](https://pypi.org/project/boosty)
[](https://github.com/pypa/hatch)
-----
**[Описание на русском](https://github.com/barsikus007/boosty/blob/master/README-ru.md)**
**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
```py
# or add these lines before first boosty import
import os
os.environ["IGNORE_MISSING_AND_EXTRA_FIELDS"] = "true"
```
*Optional:* fill `auth.json` file with authentication data (or use [browser auth](https://github.com/barsikus007/boosty/blob/master/examples/browser_auth.py) to create them):
```json
{
"access_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff",
"device_id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
"expires_at": 12345678900,
"refresh_token": "ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
}
```
Example:
```python
import asyncio
from boosty.api import API
async def main():
api = API()
response = await api.get_post("boosty", post_id="c9fb8a19-c45e-4602-9942-087c3af28c1b")
print(response.title)
# 'Добро пожаловать на борт!'
asyncio.run(main())
```
More examples in [examples/](https://github.com/barsikus007/boosty/tree/master/examples/) folder
### TODO for stable release
- inject additional data to models from requests
- convert timestamps to datetime
- serialize it to int when dumping
- schema
- complete api schema (at 100 stars)
- add access levels logic for requests
- more useful properties for models
- merge reply comment with comment model
- msgspec?
- rename folder types/ to schema/
- logic
- get rid of strange pydantic model init depends on env
- maybe better solution for auth data storage
- docs/ (at 50 stars)
- examples/
- render text
- get video url
- get comment url
- tests/
- boosty profile
- test posts under my account
- comments
- replies
- video
- entities parsing
- create dev branch
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/75/89/f3a12253fb3211fbee0f2c3ac0e7c49b9b7aa26d2875d299f971c1c41469/boosty-0.0.29.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.svg\" alt=\"BoostyPy\" height=\"250px\">\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**[\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u043d\u0430 \u0440\u0443\u0441\u0441\u043a\u043e\u043c](https://github.com/barsikus007/boosty/blob/master/README-ru.md)**\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```py\n# or add these lines before first boosty import\nimport os\n\nos.environ[\"IGNORE_MISSING_AND_EXTRA_FIELDS\"] = \"true\"\n```\n\n*Optional:* fill `auth.json` file with authentication data (or use [browser auth](https://github.com/barsikus007/boosty/blob/master/examples/browser_auth.py) to create them):\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\nimport asyncio\n\nfrom boosty.api import API\n\nasync def main():\n api = API()\n response = await api.get_post(\"boosty\", post_id=\"c9fb8a19-c45e-4602-9942-087c3af28c1b\")\n print(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\nasyncio.run(main())\n```\n\nMore examples in [examples/](https://github.com/barsikus007/boosty/tree/master/examples/) folder\n\n### TODO for stable release\n\n- inject additional data to models from requests\n- convert timestamps to datetime\n - serialize it to int when dumping\n- schema\n - complete api schema (at 100 stars)\n - add access levels logic for requests\n - more useful properties for models\n - merge reply comment with comment model\n - msgspec?\n - rename folder types/ to schema/\n- logic\n - get rid of strange pydantic model init depends on env\n - maybe better solution for auth data storage\n- docs/ (at 50 stars)\n- examples/\n - render text\n - get video url\n - get comment url\n- tests/\n - boosty profile\n - test posts under my account\n - comments\n - replies\n - video\n - entities parsing\n- create dev branch\n",
"bugtrack_url": null,
"license": null,
"summary": "Asynchronous boosty wrapper with some utils",
"version": "0.0.29",
"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": "",
"digests": {
"blake2b_256": "e3608e8eb13f4a3edabe875b0d1fe595c1d0c0174672da21630dd0e8ca0079ca",
"md5": "6e817275a2b0517843d6161bb4c3050b",
"sha256": "e5457531269b303764c79c290ef72adc01d13c5d27c7834d4f93e251c42b12ef"
},
"downloads": -1,
"filename": "boosty-0.0.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e817275a2b0517843d6161bb4c3050b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 23046,
"upload_time": "2024-10-02T12:39:51",
"upload_time_iso_8601": "2024-10-02T12:39:51.456025Z",
"url": "https://files.pythonhosted.org/packages/e3/60/8e8eb13f4a3edabe875b0d1fe595c1d0c0174672da21630dd0e8ca0079ca/boosty-0.0.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7589f3a12253fb3211fbee0f2c3ac0e7c49b9b7aa26d2875d299f971c1c41469",
"md5": "c20002d57466be5cdbbdc830f34d91fd",
"sha256": "2beeb6a2e6f3d8a8d7f4002541436fc16868589258a63148621c185da30ec198"
},
"downloads": -1,
"filename": "boosty-0.0.29.tar.gz",
"has_sig": false,
"md5_digest": "c20002d57466be5cdbbdc830f34d91fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20102,
"upload_time": "2024-10-02T12:39:52",
"upload_time_iso_8601": "2024-10-02T12:39:52.734598Z",
"url": "https://files.pythonhosted.org/packages/75/89/f3a12253fb3211fbee0f2c3ac0e7c49b9b7aa26d2875d299f971c1c41469/boosty-0.0.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 12:39:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "barsikus007",
"github_project": "boosty#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "boosty"
}
