https://github.com/4kaylum/steamfront

A Python lib for referring to Steam.
https://github.com/4kaylum/steamfront

steam

Last synced: about 13 hours ago
JSON representation

A Python lib for referring to Steam.

• Host: GitHub
• URL: https://github.com/4kaylum/steamfront
• Owner: 4Kaylum
• License: mit
• Created: 2017-01-18T20:55:47.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-01-28T20:05:40.000Z (about 8 years ago)
• Last Synced: 2024-03-29T03:46:52.590Z (10 months ago)
• Topics: steam
• Language: Python
• Size: 59.6 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Intro

Steamfront is a basic interface for working with Steam and Steampowered through Python. It should be pretty simple to use, and if there's anything badly documented here, everything is available on Github for you to look through.

**Installation**:

```bash

pip install steamfront

```

# Getting Started

There's quite basic usage. For most things you don't need an API key, but for others [you may need to get one](https://steamcommunity.com/dev/apikey).

First you need to make a `Client` object.

```python

>>> import steamfront

>>> client = steamfront.Client()

```

From there, you can get information on a game (through either name or ID), or list the games that a user has, through several methods each.

**Games**:

```python

>>> client = steamfront.Client()

>>> game = client.getApp(appid='530620')

>>> game.name

'Resident Evil 7 / Biohazard 7 Teaser: Beginning Hour'

>>> game.required_age

'18'

>>> game = client.getApp(name='Undertale')

>>> game.appid

'391540'

```

**Users**:

```python

>>> client = steamfront.Client(API_KEY)

>>> user = client.getUser(id64='76561198054243905')

>>> user.name

'Kaylum-'

>>> user.status

'Online'

>>> apps = user.apps

>>> len(apps)

137

>>> rand = apps[44]

>>> rand.play_time

409

```

Most code is fully internally documented, so it will autofill and properly interface with Python's `help` function.

# API Reference

[Click here](https://steamfront.readthedocs.io/en/latest/index.html)