| Name | steamio JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | A Python wrapper for the Steam API |
| upload_time | 2024-01-11 23:31:56 |
| maintainer | |
| docs_url | None |
| author | Gobot1234 |
| requires_python | >=3.11,<4.0 |
| license | MIT |
| keywords |
steam.py
steam
steamio
steam-api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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).
[](https://github.com/Gobot1234/steam.py/issues)
[](https://github.com/Gobot1234/steam.py/stargazers)
[](https://discord.gg/MQ68WUS)
[](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.10 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(self, trade: steam.TradeOffer) -> None:
if not trade.is_our_offer():
await trade.user.send("Thank you for your trade")
print(f"Received trade: #{trade.id}")
print("Trade partner is:", trade.user)
print("We would send:", len(trade.sending), "items")
print("We would receive:", len(trade.receiving), "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)
Raw data
{
"_id": null,
"home_page": "",
"name": "steamio",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "steam.py,steam,steamio,steam-api",
"author": "Gobot1234",
"author_email": "gobot1234yt@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/15/36cfa2965e0cb9cb7d1f87cd3603ab2bc25b36c6063446a3e6e826b3a901/steamio-1.0.1.tar.gz",
"platform": null,
"description": "# steam.py\n\nA modern, easy to use, and async ready package to interact with the Steam API. Heavily inspired by\n[discord.py](https://github.com/Rapptz/discord.py).\n\n\n\n\n[](https://github.com/Gobot1234/steam.py/issues)\n[](https://github.com/Gobot1234/steam.py/stargazers)\n[](https://discord.gg/MQ68WUS)\n[](https://github.com/Gobot1234/steam.py/actions/workflows/docs.yml)\n\n## Key Features\n\n- Modern Pythonic API using `async`/`await` syntax\n- Command extension to aid with bot creation\n- Easy to use with an object-oriented design\n- Fully typed hinted for faster development\n\n## Installation\n\n**Python 3.10 or higher is required**\n\nTo install the library just run either of the following commands:\n\n```sh\n# Linux/macOS\npython3 -m pip install -U steamio\n# Windows\npy -m pip install -U steamio\n```\n\nOr for the development version.\n\n```sh\n# Linux/macOS\npython3 -m pip install -U \"steamio @ git+https://github.com/Gobot1234/steam.py@main\"\n# Windows\npy -m pip install -U \"steamio @ git+https://github.com/Gobot1234/steam.py@main\"\n```\n\n## Quick Example\n\n```python\nimport steam\n\n\nclass MyClient(steam.Client):\n async def on_ready(self) -> None:\n print(\"Logged in as\", self.user)\n\n async def on_trade(self, trade: steam.TradeOffer) -> None:\n if not trade.is_our_offer():\n await trade.user.send(\"Thank you for your trade\")\n print(f\"Received trade: #{trade.id}\")\n print(\"Trade partner is:\", trade.user)\n print(\"We would send:\", len(trade.sending), \"items\")\n print(\"We would receive:\", len(trade.receiving), \"items\")\n\n if trade.is_gift():\n print(\"Accepting the trade as it is a gift\")\n await trade.accept()\n\n\nclient = MyClient()\nclient.run(\"username\", \"password\")\n```\n\n## Bot Example\n\n```python\nfrom steam.ext import commands\n\nbot = commands.Bot(command_prefix=\"!\")\n\n\n@bot.command\nasync def ping(ctx: commands.Context) -> None:\n await ctx.send(\"Pong!\")\n\n\nbot.run(\"username\", \"password\")\n```\n\n## Links\n\n- [Documentation](https://steam-py.github.io/docs/latest)\n- [Official Discord Server](https://discord.gg/MQ68WUS)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Python wrapper for the Steam API",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/Gobot1234/steam.py/issues",
"Code": "https://github.com/Gobot1234/steam.py",
"Documentation": "https://steam-py.github.io/docs/latest"
},
"split_keywords": [
"steam.py",
"steam",
"steamio",
"steam-api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c9ad8db1dfc4c3c53add2f89895e34aba6cfd76385475253031f01c79abd6a93",
"md5": "94e990bb1f6ede8b8ce1ba86692eaa4f",
"sha256": "0df7647e8ca4925ace3da7b8657a78ba4a430364d97360383ef857b063e54c3e"
},
"downloads": -1,
"filename": "steamio-1.0.1-cp311-cp311-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "94e990bb1f6ede8b8ce1ba86692eaa4f",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.11,<4.0",
"size": 417103,
"upload_time": "2024-01-11T23:31:54",
"upload_time_iso_8601": "2024-01-11T23:31:54.653209Z",
"url": "https://files.pythonhosted.org/packages/c9/ad/8db1dfc4c3c53add2f89895e34aba6cfd76385475253031f01c79abd6a93/steamio-1.0.1-cp311-cp311-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ec1536cfa2965e0cb9cb7d1f87cd3603ab2bc25b36c6063446a3e6e826b3a901",
"md5": "98f0b3453ce43e1d7d376b2d4b65ac78",
"sha256": "a8a0553498a1a100913bde23edf7fff1815d32419e5a43a8639773c78bcfa52f"
},
"downloads": -1,
"filename": "steamio-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "98f0b3453ce43e1d7d376b2d4b65ac78",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 358561,
"upload_time": "2024-01-11T23:31:56",
"upload_time_iso_8601": "2024-01-11T23:31:56.874682Z",
"url": "https://files.pythonhosted.org/packages/ec/15/36cfa2965e0cb9cb7d1f87cd3603ab2bc25b36c6063446a3e6e826b3a901/steamio-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-11 23:31:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gobot1234",
"github_project": "steam.py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "steamio"
}
