Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/somespecialone/aiosteampy
Trade and interact with steam market, webapi, guard.
https://github.com/somespecialone/aiosteampy
aiohttp asyncio python steam steam-trade-offers trade
Last synced: about 1 month ago
JSON representation
Trade and interact with steam market, webapi, guard.
- Host: GitHub
- URL: https://github.com/somespecialone/aiosteampy
- Owner: somespecialone
- License: mit
- Created: 2022-02-20T00:59:17.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T19:51:36.000Z (9 months ago)
- Last Synced: 2024-04-30T04:43:01.979Z (8 months ago)
- Topics: aiohttp, asyncio, python, steam, steam-trade-offers, trade
- Language: Python
- Homepage: https://aiosteampy.somespecial.one/
- Size: 516 KB
- Stars: 25
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# AIOSTEAMPY
[](https://stand-with-ukraine.pp.ua)
[](https://store.steampowered.com/)
[](https://github.com/somespecialone/aiosteampy/blob/master/LICENSE)
[](https://python-poetry.org/)
[](https://github.com/psf/black)
[](https://security.snyk.io/package/pip/aiosteampy)
[](https://pypi.org/project/aiosteampy)
[](https://pypi.org/project/aiosteampy)
[](https://github.com/somespecialone/aiosteampy/actions/workflows/tests.yml)
[](https://github.com/somespecialone/aiosteampy/actions/workflows/publish.yml)
[](https://github.com/somespecialone/aiosteampy/actions/workflows/docs.yml)
[](https://codecov.io/gh/somespecialone/aiosteampy)
[](https://www.codefactor.io/repository/github/somespecialone/aiosteampy)
[](https://snyk.io//advisor/python/aiosteampy)
Previously this library was a soft fork of [bukson/steampy](https://github.com/bukson/steampy) with intend to
provide asynchronous methods and proxies support.
But now it _standalone_ project.
> Created for steam trading purposes mostly.
Inspired by [DoctorMcKay/node-steamcommunity](https://github.com/DoctorMcKay/node-steamcommunity)
---
[](https://stand-with-ukraine.pp.ua)
> [!IMPORTANT]
> The project is unstable and there might be some breaking changes in the future unless stable (**first major**) version
> is released.
>
> Take a look at [TODO](#todo-)
>
> See full documentation [here](https://aiosteampy.somespecial.one/) 📖
## Installation
```shell
pip install aiosteampy
```
```shell
pipenv install aiosteampy
```
```shell
poetry add aiosteampy
```
Project have some extras [currencies converter](https://aiosteampy.somespecial.one/ext/converter/),
[socks proxies](https://aiosteampy.somespecial.one/proxies).
To install them all, please, use `aiosteampy[all]` install target:
```shell
poetry add aiosteampy[all]
```
> [!TIP]
> [aiohttp docs](https://docs.aiohttp.org/en/stable/#installing-all-speedups-in-one-command) recommends installing
> speedups (`aiodns`, `cchardet`, ...)
AIOSTEAMPY use [aiohttp](https://github.com/aio-libs/aiohttp) underneath to do asynchronous requests to steam servers,
with modern async/await syntax.
## Key features ✨
- **Stateless**: low-middle layer API wrapper of some steam services and methods like market,
tradeoffers, confirmations, steamguard, etc.
- **Declarative**: there is models or `TypedDict`s for every data.
- **Typed**: High-end support with extensive typing, tested on `VSCode` and `PyCharm`.
- **Simple**: Fit most important related to steam trading process methods.
- **Web proxy** support.
## What can I do with this
- Operate with steam trade offers.
- Sell, buy items on market. Place, cancel orders.
- Login trough steam to 3rd party sites.
- Fetch data from market.
- Manipulate many accounts with proxies for each session.
- Get and load cookies to stay logged in (session persistence).
- Convert market prices into different currencies.
## What I can't do
- Chat.
- Get apps, packages.
- All, that need connection to CM.
- Interact with game servers (inspect CS2 (ex. CSGO) items, ...).
- Social interaction(groups, clans).
- Handle entities (listings, items, tradeoffers) lifecycle for easy if you need to store it.
## Tests 🧪
> [!WARNING]
> Test cases and test code as a whole are deprecated and will not work until they are updated (a lot of work).
> I'll leave the code and this heading here as a reminder 🫣
[//]: # (Read [test documentation](https://aiosteampy.somespecial.one/tests/) 📖)
## TODO 📃
> Hard to say **roadmap**. Can be a little changed or updated later, get ready.
Path to first **stable release**. Non-exhaustive list, scheduled tasks can be done earlier than the version mentioned,
but not otherwise.
### v0.6.0
- [x] Listings, items, offers pagination/iteration
- [x] Get single item from inventory as browser does
- [x] Change client username method
### v0.7.0
- [x] Remove storage methods. Caching entities must be user responsibility
- [x] Rename `fetch_...` methods to `get_...` to remove annoying methods symantic mess
- [x] ~~Web browser mechanism to fetch trade offers from `Steam`, avoiding `Steam Web Api`~~
- [x] Edit profile privacy settings
### v0.8.0
- [ ] Context managers as helpers to login/logout, load/dump or get/put cookies
- [x] Fetch/paginate over market search pages
### v0.9.0
- [ ] `Steam user` model with minimal attrs, retrieving/fetching
- [x] Refresh `access_token` mechanism
### v1.0.0
- [ ] Tests with `Steam API` mocking. Target coverage ~70%. Key points (listings, inventory items, trade offers) testing
suits is mandatory
- [ ] Maturity, battle-testing in **more** different cases by **more** participants/users
## Contribution 💛
There is no rules or requirements to contribute. Feedbacks, suggests, other are welcome.
I will be very grateful for helping me get the things right.
## Credits
- [bukson/steampy](https://github.com/bukson/steampy)
- [aiohttp-socks](https://github.com/romis2012/aiohttp-socks)
- [croniter](https://github.com/kiorky/croniter)
- [DoctorMcKay/node-steamcommunity](https://github.com/DoctorMcKay/node-steamcommunity)
- [Identifying Steam items](https://dev.doctormckay.com/topic/332-identifying-steam-items/)
- [Revadike/InternalSteamWebAPI](https://github.com/Revadike/InternalSteamWebAPI)
- [Gobot1234/steam.py](https://github.com/Gobot1234/steam.py)
- [Steam Market id's storage repo](https://github.com/somespecialone/steam-item-name-ids)
- [steamapi.xpaw.me](https://steamapi.xpaw.me/)
- [Steam Exchange Rate Tracker](https://github.com/somespecialone/sert)
- [ethanfurman/aenum](https://github.com/ethanfurman/aenum)