Metadata-Version: 2.0
Name: steamfront
Version: 0.0.2
Summary: A simple plugin to allow you to nicely access things on the Steam API and web server.
Home-page: https://github.com/4Kaylum/Steamfront
Author: Callum Bartlett
Author-email: callum.b@techie.com
License: mit
Download-URL: https://github.com/4Kaylum/Steamfront/tarball/0.0.1
Keywords: steam web steamfront steampowered
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Requires-Dist: requests

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.

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.

.. code-block:: python

	>>> import steamfront
	>>> sf = 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**:

.. code-block:: python

	>>> g = sf.get_game_from_id('530620')
	>>> g.name
	'Resident Evil 7 / Biohazard 7 Teaser: Beginning Hour'
	>>> g.required_age
	'18'
	>>> g = sf.get_game_from_name('Undertale')
	>>> g.game_id
	'391540'

**Users**:

.. code-block:: python

	>>> u = sf.get_user_from_name('Kaylum-')
	>>> u.id64
	'76561198054243905'
	>>> gz = u.games
	>>> len(gz)
	138
	>>> g = gz[0]
	>>> g.name
	'Terraria'
	>>> g.play_time
	'221'

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

