| Name | steamwebapiclient JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | |
| Summary | A Python client for the Steam Web API |
| upload_time | 2024-01-07 10:29:48 |
| maintainer | |
| docs_url | None |
| author | Jasper Bok |
| requires_python | |
| license | MIT License |
| keywords |
steam
valve
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Steam Web API Client
A Python client for the [Steam Web API](https://developer.valvesoftware.com/wiki/Steam_Web_API).
Valve provides [an API endpoint](http://api.steampowered.com/ISteamWebAPIUtil/GetSupportedAPIList/v0001/)
that describes all other endpoints. This is used to automatically
generate most of the code for this package.
## Installation
This package can be installed with pip:
```shell
pip install steamwebapiclient
```
## Usage
```python
from steamwebapiclient import SteamWebClient
client = SteamWebClient(
key="YourApiKey", # Only required if calling non-public API endpoints.
steam_id="SomeSteamId", # Scopes API calls that use this to this ID.
)
domains = client.steamdirectory_getsteampipedomains()
```
## Generating the Base Client Class
To regenerate the base client class from Valve's API definitions, run
the following from the root of the project (where this README is
located).
```shell
python generate_client.py [API_KEY]
```
The `API_KEY` argument is optional, but without it, only publicly
accessible methods will be available in the generated client code.
After regenerating the client, its code must be formatted using
[black](https://black.readthedocs.io/en/stable/index.html).
## Making a Release
Install `build`:
```shell
pip install build
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "",
"name": "steamwebapiclient",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "steam,valve,api",
"author": "Jasper Bok",
"author_email": "hello@jasperbok.nl",
"download_url": "https://files.pythonhosted.org/packages/42/07/3800c8f67539e392b738d9ef01584d86efc909c0d63b7f9816237cc5288d/steamwebapiclient-0.1.0.tar.gz",
"platform": null,
"description": "# Steam Web API Client\n\nA Python client for the [Steam Web API](https://developer.valvesoftware.com/wiki/Steam_Web_API).\n\nValve provides [an API endpoint](http://api.steampowered.com/ISteamWebAPIUtil/GetSupportedAPIList/v0001/)\nthat describes all other endpoints. This is used to automatically\ngenerate most of the code for this package.\n\n## Installation\n\nThis package can be installed with pip:\n\n```shell\npip install steamwebapiclient\n```\n\n## Usage\n\n```python\nfrom steamwebapiclient import SteamWebClient\n\nclient = SteamWebClient(\n key=\"YourApiKey\", # Only required if calling non-public API endpoints.\n steam_id=\"SomeSteamId\", # Scopes API calls that use this to this ID.\n)\n\ndomains = client.steamdirectory_getsteampipedomains()\n```\n\n## Generating the Base Client Class\n\nTo regenerate the base client class from Valve's API definitions, run\nthe following from the root of the project (where this README is\nlocated).\n\n```shell\npython generate_client.py [API_KEY]\n```\n\nThe `API_KEY` argument is optional, but without it, only publicly\naccessible methods will be available in the generated client code.\n\nAfter regenerating the client, its code must be formatted using\n[black](https://black.readthedocs.io/en/stable/index.html).\n\n## Making a Release\n\nInstall `build`:\n\n```shell\npip install build\n```\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Python client for the Steam Web API",
"version": "0.1.0",
"project_urls": {
"Source": "https://github.com/jasperbok/steamwebapiclient"
},
"split_keywords": [
"steam",
"valve",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4b55aaf3660144c2adc31d41e267836c456f6258de959f184d2a42fcee99478e",
"md5": "f5196e784f34ad7ed1a60030e30a330d",
"sha256": "2e9ced2f87d73a423b12bfa7c7ee6c353a9b05dfbe632659dbe4ca3d1464ff3b"
},
"downloads": -1,
"filename": "steamwebapiclient-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5196e784f34ad7ed1a60030e30a330d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9387,
"upload_time": "2024-01-07T10:29:46",
"upload_time_iso_8601": "2024-01-07T10:29:46.325820Z",
"url": "https://files.pythonhosted.org/packages/4b/55/aaf3660144c2adc31d41e267836c456f6258de959f184d2a42fcee99478e/steamwebapiclient-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "42073800c8f67539e392b738d9ef01584d86efc909c0d63b7f9816237cc5288d",
"md5": "7880337519ddb1d30998893e378a8e23",
"sha256": "6298041d3fedd1984a9bd8a1d7e057c325d42dfd29b338ed533f3d32f3773f92"
},
"downloads": -1,
"filename": "steamwebapiclient-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7880337519ddb1d30998893e378a8e23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9762,
"upload_time": "2024-01-07T10:29:48",
"upload_time_iso_8601": "2024-01-07T10:29:48.131087Z",
"url": "https://files.pythonhosted.org/packages/42/07/3800c8f67539e392b738d9ef01584d86efc909c0d63b7f9816237cc5288d/steamwebapiclient-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 10:29:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jasperbok",
"github_project": "steamwebapiclient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "steamwebapiclient"
}
