Skip to content

Latest commit

 

History

History
171 lines (123 loc) · 6.83 KB

README.md

File metadata and controls

171 lines (123 loc) · 6.83 KB
Raw

AIOSTEAMPY

Made in Ukraine steam license Poetry black Snyk Badge pypi versions Tests Publish Docs codecov CodeFactor health

Previously this library was a soft fork of 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

Stand With Ukraine

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

See full documentation here 📖

Installation

pip install aiosteampy
pipenv install aiosteampy
poetry add aiosteampy

Project have some extras currencies converter, socks proxies. To install them all, please, use aiosteampy[all] install target:

poetry add aiosteampy[all]

Tip

aiohttp docs recommends installing speedups (aiodns, cchardet, ...)

AIOSTEAMPY use 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 TypedDicts 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 🫣

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

  • Listings, items, offers pagination/iteration
  • Get single item from inventory as browser does
  • Change client username method

v0.7.0

  • Remove storage methods. Caching entities must be user responsibility
  • Rename fetch_... methods to get_... to remove annoying methods symantic mess
  • Web browser mechanism to fetch trade offers from Steam, avoiding Steam Web Api
  • Edit profile privacy settings

v0.8.0

  • Context managers as helpers to login/logout, load/dump or get/put cookies
  • Fetch/paginate over market search pages

v0.9.0

  • Steam user model with minimal attrs, retrieving/fetching
  • 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