| Name | ValLocal JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | |
| upload_time | 2023-11-13 21:59:23 |
| maintainer | |
| docs_url | None |
| author | PWall |
| requires_python | >=3.8 |
| license | GPL-3.0 |
| keywords |
valorant
api
auth
local
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ValLocal
[](https://pypi.org/project/ValLocal/)
A Python module for interacting with the RiotClient local api.
## Features
- Automated lockfile grabbing
- Request method
- Riot auth
## Installation
The preferred method of installation is through `pip` but if you know better use the package manager that you want.
```sh
pip install ValLocal
```
## Reference
### Basic structure
ValLib contains this basic building blocks:
- `LockFile` a dataclass containing the lockfile data
And the following methods:
- `get_lockfile` to get the lockfile as a `LockFile` instance
- `local_api` to make requests to the RiotClient, using `LockFile`
- `local_auth` to get riot auth, using `LockFile`
### Ussage
```python
import ValLocal
lock = ValLocal.get_lockfile()
api_help = ValLocal.local_api(lock, "GET", "/help").text
print(api_help)
```
### Auth
Getting auth for remote endpoints
```python
import ValLocal
lock = ValLocal.get_lockfile()
auth = ValLocal.local_auth(lock)
```
This is the same auth as [ValLib](https://github.com/ValUtils/ValLib) ExtraAuth and it can be used both in [ValLib](https://github.com/ValUtils/ValLib) api and [ValWrap](https://github.com/ValUtils/ValWrap) endpoints.
## Roadmap
- [ ] Async
- [ ] WebSockets
- [ ] Better documentation
## Acknowledgements
- Thanks to [Techdoodle](https://github.com/techchrism) for his API docs
- Thanks to the Valorant App Developers discord
Raw data
{
"_id": null,
"home_page": "",
"name": "ValLocal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "valorant,api,auth,local",
"author": "PWall",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/e8/f0/f763d4f07be450995586ab25e0903ecba91cbc1e7c50caa744b13d7e1f44/ValLocal-0.1.1.tar.gz",
"platform": null,
"description": "# ValLocal\n\n[](https://pypi.org/project/ValLocal/)\n\n\n\nA Python module for interacting with the RiotClient local api.\n\n## Features\n\n- Automated lockfile grabbing\n- Request method\n- Riot auth\n\n## Installation\n\nThe preferred method of installation is through `pip` but if you know better use the package manager that you want.\n\n```sh\npip install ValLocal\n```\n\n## Reference\n\n### Basic structure\n\nValLib contains this basic building blocks:\n\n- `LockFile` a dataclass containing the lockfile data\n\nAnd the following methods:\n\n- `get_lockfile` to get the lockfile as a `LockFile` instance\n- `local_api` to make requests to the RiotClient, using `LockFile`\n- `local_auth` to get riot auth, using `LockFile`\n\n### Ussage\n\n```python\nimport ValLocal\n\nlock = ValLocal.get_lockfile()\napi_help = ValLocal.local_api(lock, \"GET\", \"/help\").text\nprint(api_help)\n```\n\n### Auth\n\nGetting auth for remote endpoints\n\n```python\nimport ValLocal\n\nlock = ValLocal.get_lockfile()\nauth = ValLocal.local_auth(lock)\n```\n\nThis is the same auth as [ValLib](https://github.com/ValUtils/ValLib) ExtraAuth and it can be used both in [ValLib](https://github.com/ValUtils/ValLib) api and [ValWrap](https://github.com/ValUtils/ValWrap) endpoints.\n\n## Roadmap\n\n- [ ] Async\n- [ ] WebSockets\n- [ ] Better documentation\n\n## Acknowledgements\n\n- Thanks to [Techdoodle](https://github.com/techchrism) for his API docs\n- Thanks to the Valorant App Developers discord\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/ValUtils/ValLocal"
},
"split_keywords": [
"valorant",
"api",
"auth",
"local"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31025b73990a6b04cf8354dc7722be8321536cae72e826597dbcc1fb2bc4daf1",
"md5": "e22608d5971f430bd8747704205223a4",
"sha256": "2422c927cfd7c8049a66d197a4be314d9e551b3e0fad2f78f17500b3314397b2"
},
"downloads": -1,
"filename": "ValLocal-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e22608d5971f430bd8747704205223a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 17727,
"upload_time": "2023-11-13T21:59:22",
"upload_time_iso_8601": "2023-11-13T21:59:22.022377Z",
"url": "https://files.pythonhosted.org/packages/31/02/5b73990a6b04cf8354dc7722be8321536cae72e826597dbcc1fb2bc4daf1/ValLocal-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8f0f763d4f07be450995586ab25e0903ecba91cbc1e7c50caa744b13d7e1f44",
"md5": "7baf98e07af426b773e4c35c0df4e75a",
"sha256": "d06b23cf2b8a4f5ba61e111c0e7ca15324c02929baac46c64f00abbfab13941f"
},
"downloads": -1,
"filename": "ValLocal-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7baf98e07af426b773e4c35c0df4e75a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16364,
"upload_time": "2023-11-13T21:59:23",
"upload_time_iso_8601": "2023-11-13T21:59:23.734093Z",
"url": "https://files.pythonhosted.org/packages/e8/f0/f763d4f07be450995586ab25e0903ecba91cbc1e7c50caa744b13d7e1f44/ValLocal-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 21:59:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ValUtils",
"github_project": "ValLocal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vallocal"
}
