steam-wrapper-api

Name	steam-wrapper-api JSON
Version	0.1 JSON
	download
home_page
Summary	unofficial steam API wrapper
upload_time	2023-05-07 23:36:17
maintainer
docs_url	None
author	Gabriel Batistuta
requires_python
license	MIT License
keywords	steam wrapper api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # steam-wrapper-api 

![steam-logo](assets/steam_logo.jpg)

## What is it?

this is an unofficial library wrapper for the steam API

**steam-wrapper-api** simplifies the use of the API, making it easier to use

# dependencies

```shell
pip install -r requirements.txt
```

# Installing

you can install using pip

```pip install steam-wrapper-api```

# Using

here are some usage examples

## making a file to auth with api_key

a json file will be generated with your api_key named API_steam.json

```python
import steam_api

steam_api.create_auth_json('YOUR_API_KEY')
```

## loading the api_key with auth file

``` python
import steam_api

api_key = steam_api.load_auth_json() 
```

## getting steam user profile data

``` python
import steam_api

steam = steam_api.Steam('YOUR_API_KEY')
profile_data = steam.get_player_summaries('steam_id')
```

## setting xml as response default

you can change the default format of response of the API to **xml**

the default is **json**
``` python
import steam_api

steam = steam_api.Steam('YOUR_API_KEY', 'xml')
```

## writing formatted data

```python
from steam_api import Steam

steam = Steam('YOUR_API_KEY')
player_achievements = steam.get_player_achievements(steam_id='xxxxxxxxxxx', app_id=000000)
steam.write_content(content=player_achievements, file_path='./player_achievements.json')

```

```output```

![formatted data](assets/formatted_data.png)

# docs

the documentation of api can be found in: ***https://developer.valvesoftware.com/wiki/Steam_Web_API#GetNewsForApp_.28v0001.29***

# contributing

all contributions are welcome, the repository in github is: ***https://github.com/gabriel-batistuta/steam-wrapper-api***

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "steam-wrapper-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "steam,wrapper,api",
    "author": "Gabriel Batistuta",
    "author_email": "batistutag190@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/6a/53/0278a2c9b1854db18c19b12d2b652e0fc3954b2bedeb3b9f11d96ed0ee45/steam-wrapper-api-0.1.tar.gz",
    "platform": null,
    "description": "# steam-wrapper-api \n\n![steam-logo](assets/steam_logo.jpg)\n\n## What is it?\n\nthis is an unofficial library wrapper for the steam API\n\n**steam-wrapper-api** simplifies the use of the API, making it easier to use\n\n# dependencies\n\n```shell\npip install -r requirements.txt\n```\n\n# Installing\n\nyou can install using pip\n\n```pip install steam-wrapper-api```\n\n# Using\n\nhere are some usage examples\n\n## making a file to auth with api_key\n\na json file will be generated with your api_key named API_steam.json\n\n```python\nimport steam_api\n\nsteam_api.create_auth_json('YOUR_API_KEY')\n```\n\n## loading the api_key with auth file\n\n``` python\nimport steam_api\n\napi_key = steam_api.load_auth_json() \n```\n\n## getting steam user profile data\n\n``` python\nimport steam_api\n\nsteam = steam_api.Steam('YOUR_API_KEY')\nprofile_data = steam.get_player_summaries('steam_id')\n```\n\n## setting xml as response default\n\nyou can change the default format of response of the API to **xml**\n\nthe default is **json**\n``` python\nimport steam_api\n\nsteam = steam_api.Steam('YOUR_API_KEY', 'xml')\n```\n\n## writing formatted data\n\n```python\nfrom steam_api import Steam\n\nsteam = Steam('YOUR_API_KEY')\nplayer_achievements = steam.get_player_achievements(steam_id='xxxxxxxxxxx', app_id=000000)\nsteam.write_content(content=player_achievements, file_path='./player_achievements.json')\n\n```\n\n```output```\n\n![formatted data](assets/formatted_data.png)\n\n# docs\n\nthe documentation of api can be found in: ***https://developer.valvesoftware.com/wiki/Steam_Web_API#GetNewsForApp_.28v0001.29***\n\n# contributing\n\nall contributions are welcome, the repository in github is: ***https://github.com/gabriel-batistuta/steam-wrapper-api***\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "unofficial steam API wrapper",
    "version": "0.1",
    "project_urls": null,
    "split_keywords": [
        "steam",
        "wrapper",
        "api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a530278a2c9b1854db18c19b12d2b652e0fc3954b2bedeb3b9f11d96ed0ee45",
                "md5": "35c58bfd66040e249935467ac424578b",
                "sha256": "2b3323cd97688d793016c71145c371aeb1d10a69bf1d709d70844b99969e53a8"
            },
            "downloads": -1,
            "filename": "steam-wrapper-api-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "35c58bfd66040e249935467ac424578b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4123,
            "upload_time": "2023-05-07T23:36:17",
            "upload_time_iso_8601": "2023-05-07T23:36:17.730895Z",
            "url": "https://files.pythonhosted.org/packages/6a/53/0278a2c9b1854db18c19b12d2b652e0fc3954b2bedeb3b9f11d96ed0ee45/steam-wrapper-api-0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-07 23:36:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "steam-wrapper-api"
}