steampie 0.2.0__tar.gz

steampie-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Upload Python Package
+on:
+  release:
+    types: [published]
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - run: python3 -m pip install --upgrade build && python3 -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

steampie-0.2.0/.gitignore

@@ -0,0 +1,175 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# steampie
+credentials.json
+*.maFile

steampie-0.2.0/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "[python]": {
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "explicit"
+        }
+    }
+}

steampie-0.2.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2016 Michał Bukowski gigibukson@gmail.com
+Copyright (c) 2024 offish
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

steampie-0.2.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.1
+Name: steampie
+Version: 0.2.0
+Summary: Interact with Steam using Python 3
+Author-email: offish <overutilization@gmail.com>
+Project-URL: Homepage, https://github.com/offish/steampie
+Project-URL: Bug Tracker, https://github.com/offish/steampie/issues
+Keywords: steam,steampie,steampy,steamio
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rsa
+Requires-Dist: beautifulsoup4
+Requires-Dist: requests
+
+# steampie
+[![License](https://img.shields.io/github/license/offish/steampie.svg)](https://github.com/offish/steampie/blob/master/LICENSE)
+[![Stars](https://img.shields.io/github/stars/offish/steampie.svg)](https://github.com/offish/steampie/stargazers)
+[![Issues](https://img.shields.io/github/issues/offish/steampie.svg)](https://github.com/offish/steampie/issues)
+[![Size](https://img.shields.io/github/repo-size/offish/steampie.svg)](https://github.com/offish/steampie)
+[![Discord](https://img.shields.io/discord/467040686982692865?color=7289da&label=Discord&logo=discord)](https://discord.gg/t8nHSvA)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+`steampie` is a Python library for interacting with Steam, and is a modified fork of [bukson](https://github.com/bukson)'s [steampy](https://github.com/bukson/steampy).
+
+## Donate
+* BTC: `bc1qntlxs7v76j0zpgkwm62f6z0spsvyezhcmsp0z2` (offish)
+* [Steam Trade Offer](https://steamcommunity.com/tradeoffer/new/?partner=293059984&token=0-l_idZR) (offish)
+* BTC (bukson): `3PRzESHsTVkCFK7osjwFGQLZjSf7qXP1Ta` (bukson)
+* [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XC8BMJ8QRD9ZY) (bukson)
+
+## Installation
+```bash
+pip install steampie
+```
+
+### Update
+```bash
+pip install --upgrade steampie
+```
+
+## Differences from `steampy`
+<!-- * Added functionality for adding/removing friends -->
+* Removed market functionality due to Steam having strict ToS regarding market automation
+* Uses [ruff](https://github.com/astral-sh/ruff) for formatting and linting
+* Uses [pytest](https://pytest.org/) for unit tests
+
+<!-- ## Usage
+
+
+## Examples
+
+
+## Developing -->
+
+
+### Tests
+```bash
+# steampie/
+pytest
+```
+
+### Building documentation
+```bash
+# steampie/
+cd docs/
+make clean
+make html
+```
+
+## License
+MIT License
+
+Copyright (c) 2016 [Michał Bukowski](mailto:gigibukson@gmail.com) <br>
+Copyright (c) 2024 offish ([confern](https://steamcommunity.com/id/confern))
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

steampie-0.2.0/README.md

@@ -0,0 +1,78 @@
+# steampie
+[![License](https://img.shields.io/github/license/offish/steampie.svg)](https://github.com/offish/steampie/blob/master/LICENSE)
+[![Stars](https://img.shields.io/github/stars/offish/steampie.svg)](https://github.com/offish/steampie/stargazers)
+[![Issues](https://img.shields.io/github/issues/offish/steampie.svg)](https://github.com/offish/steampie/issues)
+[![Size](https://img.shields.io/github/repo-size/offish/steampie.svg)](https://github.com/offish/steampie)
+[![Discord](https://img.shields.io/discord/467040686982692865?color=7289da&label=Discord&logo=discord)](https://discord.gg/t8nHSvA)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+`steampie` is a Python library for interacting with Steam, and is a modified fork of [bukson](https://github.com/bukson)'s [steampy](https://github.com/bukson/steampy).
+
+## Donate
+* BTC: `bc1qntlxs7v76j0zpgkwm62f6z0spsvyezhcmsp0z2` (offish)
+* [Steam Trade Offer](https://steamcommunity.com/tradeoffer/new/?partner=293059984&token=0-l_idZR) (offish)
+* BTC (bukson): `3PRzESHsTVkCFK7osjwFGQLZjSf7qXP1Ta` (bukson)
+* [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XC8BMJ8QRD9ZY) (bukson)
+
+## Installation
+```bash
+pip install steampie
+```
+
+### Update
+```bash
+pip install --upgrade steampie
+```
+
+## Differences from `steampy`
+<!-- * Added functionality for adding/removing friends -->
+* Removed market functionality due to Steam having strict ToS regarding market automation
+* Uses [ruff](https://github.com/astral-sh/ruff) for formatting and linting
+* Uses [pytest](https://pytest.org/) for unit tests
+
+<!-- ## Usage
+
+
+## Examples
+
+
+## Developing -->
+
+
+### Tests
+```bash
+# steampie/
+pytest
+```
+
+### Building documentation
+```bash
+# steampie/
+cd docs/
+make clean
+make html
+```
+
+## License
+MIT License
+
+Copyright (c) 2016 [Michał Bukowski](mailto:gigibukson@gmail.com) <br>
+Copyright (c) 2024 offish ([confern](https://steamcommunity.com/id/confern))
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

steampie-0.2.0/conftest.py

@@ -0,0 +1,70 @@
+import json
+from base64 import b64encode
+
+import pytest
+
+from steampie.client import SteamClient
+
+
+def my_steam_id() -> str:
+    return "76561198253325712"
+
+
+@pytest.fixture
+def partner_steam_id() -> str:
+    return "76561198155938401"
+
+
+@pytest.fixture
+def partner_trade_url() -> str:
+    return "https://steamcommunity.com/tradeoffer/new/?partner=195672673&token=k3YfpXNU"
+
+
+@pytest.fixture
+def shared_secret() -> bytes:
+    return b64encode(b"1234567890abcdefghij")
+
+
+@pytest.fixture
+def identity_secret() -> bytes:
+    return b64encode(b"abcdefghijklmnoprstu")
+
+
+def get_credentials() -> dict:
+    steam_credentials = {}
+
+    with open("./credentials.json", "r") as f:
+        steam_credentials = json.load(f)
+
+    return steam_credentials
+
+
+@pytest.fixture
+def credentials() -> dict:
+    return get_credentials()
+
+
+@pytest.fixture
+def steam_guard_file() -> dict:
+    steam_guard_credentials = {}
+    steam_id = my_steam_id()
+
+    with open(f"./{steam_id}.maFile", "r") as f:
+        steam_guard_credentials = json.load(f)
+
+    steam_credentials = get_credentials()
+
+    steam_guard_credentials["password"] = steam_credentials["password"]
+    steam_guard_credentials["api_key"] = steam_credentials["api_key"]
+
+    return steam_guard_credentials
+
+
+steam_credentials = get_credentials()
+steam_client = SteamClient(**steam_credentials)
+steam_client.login()
+
+
+@pytest.fixture
+def client() -> SteamClient:
+    return steam_client

steampie-0.2.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

steampie-0.2.0/docs/conf.py

@@ -0,0 +1,67 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# flake8: noqa
+import re
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+sys.path.append(os.path.abspath("extensions"))
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "steampie"
+copyright = "2024, offish"
+author = "offish"
+
+with open("src/steampie/__init__.py") as f:
+    version = re.search(
+        r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', f.read(), re.MULTILINE
+    ).group(1)
+
+# The full version, including alpha/beta/rc tags
+release = version
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+extensions = [
+    "sphinxcontrib.jquery",
+    "sphinx.ext.duration",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx_rtd_theme",
+    "sphinx.ext.napoleon",
+]
+
+autodoc_member_order = "bysource"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True
+
+html_theme = "furo"

steampie-0.2.0/docs/index.rst

@@ -0,0 +1,10 @@
+.. include:: ../README.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pages/client
+   pages/models
+   pages/exceptions
+   pages/utils

steampie-0.2.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

steampie-0.2.0/docs/pages/client.rst

@@ -0,0 +1,6 @@
+client
+------
+.. automodule:: src.steampie.client
+    :members:
+    :undoc-members:
+    :private-members:

steampie-0.2.0/docs/pages/exceptions.rst

@@ -0,0 +1,6 @@
+exceptions
+----------
+.. automodule:: src.steampie.exceptions
+    :members:
+    :undoc-members:
+    :private-members:

steampie-0.2.0/docs/pages/models.rst

@@ -0,0 +1,6 @@
+models
+------
+.. automodule:: src.steampie.models
+    :members:
+    :undoc-members:
+    :private-members:

steampie-0.2.0/docs/pages/utils.rst

@@ -0,0 +1,6 @@
+utils
+-----
+.. automodule:: src.steampie.utils
+    :members:
+    :undoc-members:
+    :private-members:

steampie-0.2.0/example_credentials.json

@@ -0,0 +1,7 @@
+{
+    "api_key": "FDSHJ428768GDJ43",
+    "username": "username",
+    "password": "password",
+    "identity_secret": "ds6432ghjs6732ghdsjaas=",
+    "shared_secret": "dsa732gfdsds427fdsjfg="
+}

steampie-0.2.0/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "steampie"
+authors = [
+  { name="offish", email="overutilization@gmail.com" },
+]
+description = "Interact with Steam using Python 3"
+readme = "README.md"
+requires-python = ">=3.12"
+keywords = ["steam", "steampie", "steampy", "steamio"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = ["rsa", "beautifulsoup4", "requests"]
+dynamic = ["version"]
+
+[project.urls]
+"Homepage" = "https://github.com/offish/steampie"
+"Bug Tracker" = "https://github.com/offish/steampie/issues"
+
+[tool.setuptools_scm]

steampie-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

steampie-0.2.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()