Metadata-Version: 2.1
Name: steamio
Version: 0.4.0
Summary: A Python wrapper for the Steam API
Home-page: https://github.com/Gobot1234/steam.py
Author: Gobot1234
License: MIT
Download-URL: https://github.com/Gobot1234/steam.py/archive/0.4.0.tar.gz
Project-URL: Documentation, https://steampy.readthedocs.io/en/latest
Project-URL: Code, https://github.com/Gobot1234/steam.py
Project-URL: Issue tracker, https://github.com/Gobot1234/steam.py/issues
Keywords: steam.py steam steamio steam-api
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
Requires-Dist: aiohttp (<3.7.0,>=3.6.0)
Requires-Dist: beautifulsoup4 (>=4.9.1)
Requires-Dist: rsa (>=4.6)
Requires-Dist: betterproto (>=1.2.5)
Requires-Dist: typing-extensions (>=3.7.4.2)
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-asyncio ; extra == 'dev'
Requires-Dist: pyyaml ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx (==3.2.1) ; extra == 'docs'
Requires-Dist: sphinxcontrib-trio (==1.1.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-websupport ; extra == 'docs'

steam.py
=========

A modern, easy to use, and async ready package to interact with the Steam API. Heavily inspired by 
[discord.py](https://github.com/Rapptz/discord.py) and borrowing functionality from [ValvePython/steam](https://github.com/ValvePython/steam).

![Supports](https://img.shields.io/pypi/pyversions/steamio) ![Version](https://img.shields.io/pypi/v/steamio?color=%2366c0f4) ![License](https://img.shields.io/github/license/Gobot1234/steam.py) [![Codacy](https://img.shields.io/codacy/grade/a0405599d4ab4a8c82655873d7443532)](https://app.codacy.com/manual/Gobot1234/steam.py) [![GitHub issues](https://img.shields.io/github/issues-raw/Gobot1234/steam.py)](https://github.com/Gobot1234/steam.py/issues) [![GitHub stars](https://img.shields.io/github/stars/Gobot1234/steam.py)](https://github.com/Gobot1234/steam.py/stargazers) [![Discord](https://img.shields.io/discord/678629505094647819?color=7289da&label=Discord&logo=discord)](https://discord.gg/MQ68WUS)

Key Features
--------------

- Modern Pythonic API using ``async``/``await`` syntax
- Command extension to aid with bot creation
- Easy to use with an object oriented design
- Fully typed

Installation
--------------

**Python 3.7 or higher is required**

To install the library just run either of the following commands:

```sh
# Linux/macOS
python3 -m pip install -U steamio
# Windows
py -m pip install -U steamio
```

Or for the development version.

```sh
git clone https://github.com/Gobot1234/steam.py
cd steam.py
python3 -m pip install -U ".[dev]"
```

Quick Example
--------------

```py
import steam


class MyClient(steam.Client):
    async def on_ready(self):
        print("Logged in as", self.user)

    async def on_trade_receive(self, trade):
        await trade.partner.send("Thank you for your trade")
        print(f"Received trade: #{trade.id}")
        print("Trade partner is:", trade.partner)
        print("We would send:", len(trade.items_to_send), "items")
        print("We would receive:", len(trade.items_to_receive), "items")

        if trade.is_gift():
            print("Accepting the trade as it is a gift")
            await trade.accept()


client = MyClient()
client.run("username", "password")
```

Links
------

  - [Documentation](https://steampy.rtfd.io/en/latest/index.html)
  - [Official Discord Server](https://discord.gg/MQ68WUS)

##### Please note this repo is under going rapid development, if you find any bugs please make a [new issue](https://github.com/Gobot1234/steam.py/issues/new).


