aiosteampy

Trade and interact with steam market, webapi, guard

https://github.com/somespecialone/aiosteampy

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary

Keywords

aiohttp asyncio python steam steam-trade-offers trade

Keywords from Contributors

interactive mesh interpretability profiles sequences generic projection standardization optim embedded
Last synced: 6 months ago · JSON representation ·

Repository

Trade and interact with steam market, webapi, guard

Basic Info
Statistics
  • Stars: 67
  • Watchers: 8
  • Forks: 8
  • Open Issues: 6
  • Releases: 40
Topics
aiohttp asyncio python steam steam-trade-offers trade
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

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

shell pip install aiosteampy

shell pipenv install aiosteampy

shell poetry add aiosteampy

shell uv add aiosteampy

Project does have extras as socks proxies and currencies converter.

Either of extras can be installed separately with the appropriate installation target: aiosteampy[socks] or aiosteampy[converter].

Or all extras at once aiosteampy[all].

An UV example

shell uv add aiosteampy[socks]

[!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

  • [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

Owner

  • Name: Dmytro
  • Login: somespecialone
  • Kind: user
  • Location: Ukraine

Add a bio

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: aiosteampy
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Dmytro
    family-names: Tkachenko
    email: itsme@somespecial.one
repository-code: "https://github.com/somespecialone/aiosteampy"
url: "https://aiosteampy.somespecial.one/"
repository-artifact: "https://pypi.org/project/aiosteampy/"
abstract: >-
  Trade and interact with steam market, webapi, guard.
keywords:
  - python
  - asyncio
  - steam
license: MIT

GitHub Events

Total
  • Create event: 14
  • Commit comment event: 1
  • Issues event: 19
  • Release event: 16
  • Watch event: 28
  • Delete event: 1
  • Issue comment event: 37
  • Push event: 27
  • Pull request review event: 3
  • Pull request review comment event: 2
  • Pull request event: 5
  • Fork event: 8
Last Year
  • Create event: 14
  • Commit comment event: 1
  • Issues event: 19
  • Release event: 16
  • Watch event: 28
  • Delete event: 1
  • Issue comment event: 37
  • Push event: 27
  • Pull request review event: 3
  • Pull request review comment event: 2
  • Pull request event: 5
  • Fork event: 8

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 122
  • Total Committers: 3
  • Avg Commits per committer: 40.667
  • Development Distribution Score (DDS): 0.074
Past Year
  • Commits: 62
  • Committers: 2
  • Avg Commits per committer: 31.0
  • Development Distribution Score (DDS): 0.016
Top Committers
Name Email Commits
somespecialone t****y@y****m 113
dependabot[bot] 4****] 8
ultra2207 1****7 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 69
  • Average time to close issues: 20 days
  • Average time to close pull requests: about 1 month
  • Total issue authors: 9
  • Total pull request authors: 6
  • Average comments per issue: 2.73
  • Average comments per pull request: 0.91
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 62
Past Year
  • Issues: 11
  • Pull requests: 7
  • Average time to close issues: 1 day
  • Average time to close pull requests: about 23 hours
  • Issue authors: 7
  • Pull request authors: 5
  • Average comments per issue: 1.73
  • Average comments per pull request: 1.43
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • yesworId (4)
  • somespecialone (2)
  • tima1906 (2)
  • ultra2207 (2)
  • Qfront (1)
  • 5har0varik (1)
  • VlexWest (1)
  • ha-mark (1)
  • Cheekk1 (1)
Pull Request Authors
  • dependabot[bot] (65)
  • ultra2207 (3)
  • 5har0varik (2)
  • tima1906 (1)
  • schv (1)
  • ClydexGG (1)
Top Labels
Issue Labels
bug (10) enhancement (2)
Pull Request Labels
dependencies (65) python (46) github_actions (4) bug (2) enhancement (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 393 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 36
  • Total maintainers: 1
pypi.org: aiosteampy

Trade and interact with steam market, webapi, guard

  • Versions: 36
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 393 Last month
Rankings
Dependent packages count: 6.6%
Downloads: 12.9%
Stargazers count: 16.6%
Average: 19.5%
Forks count: 30.5%
Dependent repos count: 30.6%
Maintainers (1)
Last synced: 6 months ago

Dependencies

poetry.lock pypi
  • aiohttp-socks 0.7.1 develop
  • atomicwrites 1.4.0 develop
  • black 22.3.0 develop
  • click 8.0.4 develop
  • colorama 0.4.4 develop
  • coverage 6.4 develop
  • iniconfig 1.1.1 develop
  • mypy-extensions 0.4.3 develop
  • packaging 21.3 develop
  • pathspec 0.9.0 develop
  • platformdirs 2.5.1 develop
  • pluggy 1.0.0 develop
  • py 1.11.0 develop
  • pyparsing 3.0.7 develop
  • pytest 7.1.2 develop
  • pytest-asyncio 0.18.3 develop
  • pytest-cov 3.0.0 develop
  • pytest-mock 3.7.0 develop
  • python-socks 2.0.3 develop
  • tomli 2.0.1 develop
  • aiohttp 3.8.1
  • aiosignal 1.2.0
  • async-timeout 4.0.2
  • attrs 21.4.0
  • beautifulsoup4 4.11.1
  • charset-normalizer 2.0.12
  • frozenlist 1.3.0
  • idna 3.3
  • multidict 6.0.2
  • pyasn1 0.4.8
  • rsa 4.8
  • soupsieve 2.3.1
  • yarl 1.7.2
pyproject.toml pypi
  • aiohttp-socks ^0.7.1 develop
  • black ^22.3.0 develop
  • pytest ^7.1.2 develop
  • pytest-asyncio ^0.18.3 develop
  • pytest-cov ^3.0.0 develop
  • pytest-mock ^3.7.0 develop
  • aiohttp ^3.8.1
  • beautifulsoup4 ^4.10.0
  • python ^3.10
  • rsa ^4.8
.github/workflows/docs.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
.github/workflows/publish.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • snok/install-poetry v1 composite
.github/workflows/tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3 composite
  • snok/install-poetry v1 composite