Metadata-Version: 2.1
Name: steamio
Version: 0.9.9
Summary: A Python wrapper for the Steam API
License: MIT
Keywords: steam.py,steam,steamio,steam-api
Author: Gobot1234
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: aiohttp (>=3.7,<3.9)
Requires-Dist: beautifulsoup4 (>=4.10,<5.0)
Requires-Dist: betterproto (==2.0.0b4)
Requires-Dist: cryptography (>=37.0,<38.0)
Requires-Dist: tomli (>=2,<3) ; python_version < "3.11"
Requires-Dist: typing-extensions (==4.2.0)
Requires-Dist: vdf (>=3.4,<4.0)
Project-URL: Bug Tracker, https://github.com/Gobot1234/steam.py/issues
Project-URL: Code, https://github.com/Gobot1234/steam.py
Project-URL: Documentation, https://steam-py.github.io/docs/latest
Description-Content-Type: text/markdown

# 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)
[![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)
[![Documentation Status](https://github.com/Gobot1234/steam.py/actions/workflows/docs.yml/badge.svg)](https://github.com/Gobot1234/steam.py/actions/workflows/docs.yml)

## 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 hinted for faster development

## 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
# Linux/macOS
python3 -m pip install -U "steamio @ git+https://github.com/Gobot1234/steam.py@main"
# Windows
py -m pip install -U "steamio @ git+https://github.com/Gobot1234/steam.py@main"
```

## Quick Example

```python
import steam


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

    async def on_trade_receive(self, trade: steam.TradeOffer) -> None:
        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")
```

## Bot Example

```python
from steam.ext import commands

bot = commands.Bot(command_prefix="!")


@bot.command
async def ping(ctx: commands.Context) -> None:
    await ctx.send("Pong!")


bot.run("username", "password")
```

## Links

- [Documentation](https://steam-py.github.io/docs/latest/)
- [Official Discord Server](https://discord.gg/MQ68WUS)

