steam-picker 0.1.7__tar.gz

steam_picker-0.1.7/.gitignore

@@ -0,0 +1,5 @@
+__pycache__
+*egg-info
+build/
+dist/
+*.mypy

steam_picker-0.1.7/LICENSE.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

steam_picker-0.1.7/PKG-INFO

@@ -0,0 +1,133 @@
+Metadata-Version: 2.5
+Name: steam-picker
+Version: 0.1.7
+Summary: Pick a random game from your personal Steam library!
+Project-URL: Homepage, https://github.com/holocronweaver/steam-picker
+Project-URL: Repository, https://github.com/holocronweaver/steam-picker
+Project-URL: Issues, https://github.com/holocronweaver/steam-picker/issues
+Author-email: Jesse Johnson <1024369+holocronweaver@users.noreply.github.com>
+License-Expression: MPL-2.0
+License-File: LICENSE.txt
+Keywords: cli,games,picker,random,steam
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Games/Entertainment
+Requires-Python: <4,>=3.10
+Requires-Dist: appdirs<2,>=1.4.4
+Requires-Dist: pyyaml~=6.0
+Requires-Dist: requests<3,>=2.31.0
+Requires-Dist: steam<2,>=1.4.3
+Description-Content-Type: text/markdown
+
+A Python 3 CLI for picking a random game from your Steam library!
+
+# Features
+
+-   customizable filters (co-op, multiplayer, VR, high Metacritic rating, and more!)
+-   concise game metadata (summary, platforms, categories, playtime, Metacritic score, etc.)
+-   remembers your Steam ID and API key, only have to enter once
+
+# Installation
+
+**Requires Python 3.10 or higher.**
+
+## pipx [recommended]
+
+[Install pipx](https://pipx.pypa.io/) if you haven't already, then run:
+
+`pipx install steam-picker`
+
+To install from source instead, run the following command in the app root directory:
+
+`pipx install .`
+
+Add the `--editable` flag if you want to hack on the source code and have your changes automatically reflected in the installed app:
+
+`pipx install --editable .`
+
+## uvx
+
+[Install uv](https://docs.astral.sh/uv/) if you haven't already, then run the following command to run the app without installing it:
+
+`uvx steam-picker`
+
+To run from source instead, run the following command in the app root directory:
+
+`uvx --from . steam-picker`
+
+uv caches the built app, so add the `--reinstall` flag to pick up any changes to the source code:
+
+`uvx --reinstall --from . steam-picker`
+
+## pip
+
+Run the following command:
+
+`pip3 install --user steam-picker`
+
+To install from source instead, run `pip3 install --user .` in the app root directory.
+
+Feel free to omit the `--user` flag if you normally install packages
+to the root directory.
+
+# Usage
+
+Assuming your Python package bin is in your `$PATH`, just run `steam-picker` from the command line.
+
+    Pick a game from your personal Steam library!
+    
+    <enter your Steam profile URL and API key>
+    
+    How about... 'Zeno Clash 2'?
+    
+    Categories: ['Single-player', 'Co-op', 'Steam Achievements', 'Full controller support', 'Steam Trading Cards', 'Steam Cloud', 'Steam Leaderboards']
+    Genres:     ['Action', 'Indie']
+    Platforms:  ['windows']
+    Playtime:   {'hours': 0}
+    Steam URL:  https://store.steampowered.com/app/215690/
+    
+    [y = accept, n or q = quit, f = filter, other = continue]: f
+    
+    See filters.py to customize quick filters and add default filters.
+    
+    Quick filters
+    =============
+    coop:       Co-op games.
+    high:       Metracritic scores > 70. (Filters out games without Metacritic scores.)
+    linux:      Linux support.
+    multi:      Multiplayer.
+    vr:         VR support. (Steam store metadata does not categorize all VR-capable games, so this will miss some.)
+    unplayed:   Played less than an hour.
+    
+    [Quick filter alias <or> Python lambda x: filter body to add <or> filter ID to delete]: coop
+    
+    How about... 'Secrets of Grindea'?
+    
+    Summary:    A fantasy Action RPG, playable by yourself or in co-op with up to three friends! Features an unrestricted skill system, fluid and challenging combat, and an engaging story. For additional value, there's also a fleshed out, challenging roguelike mode to truly put your ARPG skills to the test!
+    Categories: ['Single-player', 'Online Multi-Player', 'Co-op', 'Steam Achievements', 'Full controller support', 'Steam Cloud', 'Steam Leaderboards']
+    Genres:     ['Action', 'Adventure', 'Indie', 'RPG', 'Early Access']
+    Platforms:  ['windows']
+    Playtime:   {'hours': 1}
+    Steam URL:  https://store.steampowered.com/app/269770/
+    
+    [y = accept, n or q = quit, f = filter, other = continue]: y
+    
+    Alright, 'Secrets of Grindea' it is.
+    
+    ░▐█▀█ ▄▀▄ █▀▀▄ ▀█▀ ▀▄─▄▀──░█▀█▀█ ▀ █▄─▄█ █▀▀░█░█░█
+    ░▐█▄█ █▀█ █▐█▀ ─█─ ──█──────░█── █ █─█─█ █▀▀─▀─▀─▀
+    ░▐█── ▀─▀ ▀─▀▀ ─▀─ ──▀─────░▄█▄─ ▀ ▀───▀ ▀▀▀░▄░▄░▄
+
+# Development
+
+To develop this package or run it without installing:
+
+1. Install [uv](https://docs.astral.sh/uv/).
+1. Run the app: `uv run steam-picker`
+1. Build the app for distribution (see `dist` directory for wheel and archive): `uv build`
+1. Publish the app to PyPI: `uv publish dist/steam_picker-<version>*`
+

steam_picker-0.1.7/README.md

@@ -0,0 +1,108 @@
+A Python 3 CLI for picking a random game from your Steam library!
+
+# Features
+
+-   customizable filters (co-op, multiplayer, VR, high Metacritic rating, and more!)
+-   concise game metadata (summary, platforms, categories, playtime, Metacritic score, etc.)
+-   remembers your Steam ID and API key, only have to enter once
+
+# Installation
+
+**Requires Python 3.10 or higher.**
+
+## pipx [recommended]
+
+[Install pipx](https://pipx.pypa.io/) if you haven't already, then run:
+
+`pipx install steam-picker`
+
+To install from source instead, run the following command in the app root directory:
+
+`pipx install .`
+
+Add the `--editable` flag if you want to hack on the source code and have your changes automatically reflected in the installed app:
+
+`pipx install --editable .`
+
+## uvx
+
+[Install uv](https://docs.astral.sh/uv/) if you haven't already, then run the following command to run the app without installing it:
+
+`uvx steam-picker`
+
+To run from source instead, run the following command in the app root directory:
+
+`uvx --from . steam-picker`
+
+uv caches the built app, so add the `--reinstall` flag to pick up any changes to the source code:
+
+`uvx --reinstall --from . steam-picker`
+
+## pip
+
+Run the following command:
+
+`pip3 install --user steam-picker`
+
+To install from source instead, run `pip3 install --user .` in the app root directory.
+
+Feel free to omit the `--user` flag if you normally install packages
+to the root directory.
+
+# Usage
+
+Assuming your Python package bin is in your `$PATH`, just run `steam-picker` from the command line.
+
+    Pick a game from your personal Steam library!
+    
+    <enter your Steam profile URL and API key>
+    
+    How about... 'Zeno Clash 2'?
+    
+    Categories: ['Single-player', 'Co-op', 'Steam Achievements', 'Full controller support', 'Steam Trading Cards', 'Steam Cloud', 'Steam Leaderboards']
+    Genres:     ['Action', 'Indie']
+    Platforms:  ['windows']
+    Playtime:   {'hours': 0}
+    Steam URL:  https://store.steampowered.com/app/215690/
+    
+    [y = accept, n or q = quit, f = filter, other = continue]: f
+    
+    See filters.py to customize quick filters and add default filters.
+    
+    Quick filters
+    =============
+    coop:       Co-op games.
+    high:       Metracritic scores > 70. (Filters out games without Metacritic scores.)
+    linux:      Linux support.
+    multi:      Multiplayer.
+    vr:         VR support. (Steam store metadata does not categorize all VR-capable games, so this will miss some.)
+    unplayed:   Played less than an hour.
+    
+    [Quick filter alias <or> Python lambda x: filter body to add <or> filter ID to delete]: coop
+    
+    How about... 'Secrets of Grindea'?
+    
+    Summary:    A fantasy Action RPG, playable by yourself or in co-op with up to three friends! Features an unrestricted skill system, fluid and challenging combat, and an engaging story. For additional value, there's also a fleshed out, challenging roguelike mode to truly put your ARPG skills to the test!
+    Categories: ['Single-player', 'Online Multi-Player', 'Co-op', 'Steam Achievements', 'Full controller support', 'Steam Cloud', 'Steam Leaderboards']
+    Genres:     ['Action', 'Adventure', 'Indie', 'RPG', 'Early Access']
+    Platforms:  ['windows']
+    Playtime:   {'hours': 1}
+    Steam URL:  https://store.steampowered.com/app/269770/
+    
+    [y = accept, n or q = quit, f = filter, other = continue]: y
+    
+    Alright, 'Secrets of Grindea' it is.
+    
+    ░▐█▀█ ▄▀▄ █▀▀▄ ▀█▀ ▀▄─▄▀──░█▀█▀█ ▀ █▄─▄█ █▀▀░█░█░█
+    ░▐█▄█ █▀█ █▐█▀ ─█─ ──█──────░█── █ █─█─█ █▀▀─▀─▀─▀
+    ░▐█── ▀─▀ ▀─▀▀ ─▀─ ──▀─────░▄█▄─ ▀ ▀───▀ ▀▀▀░▄░▄░▄
+
+# Development
+
+To develop this package or run it without installing:
+
+1. Install [uv](https://docs.astral.sh/uv/).
+1. Run the app: `uv run steam-picker`
+1. Build the app for distribution (see `dist` directory for wheel and archive): `uv build`
+1. Publish the app to PyPI: `uv publish dist/steam_picker-<version>*`
+

steam_picker-0.1.7/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "steam-picker"
+version = "0.1.7"
+description = "Pick a random game from your personal Steam library!"
+authors = [{ name = "Jesse Johnson", email = "1024369+holocronweaver@users.noreply.github.com" }]
+requires-python = ">=3.10, <4"
+readme = "README.md"
+license = "MPL-2.0"
+keywords = ["steam", "games", "random", "picker", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Games/Entertainment",
+]
+dependencies = [
+    "appdirs>=1.4.4,<2",
+    "PyYAML~=6.0",
+    "requests>=2.31.0,<3",
+    "steam>=1.4.3,<2",
+]
+
+[project.urls]
+Homepage = "https://github.com/holocronweaver/steam-picker"
+Repository = "https://github.com/holocronweaver/steam-picker"
+Issues = "https://github.com/holocronweaver/steam-picker/issues"
+
+[project.scripts]
+steam-picker = "steampicker.steampicker:run"
+
+[dependency-groups]
+dev = []
+
+[tool.hatch.build.targets.sdist]
+include = ["steampicker"]
+
+[tool.hatch.build.targets.wheel]
+include = ["steampicker"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

steam_picker-0.1.7/steampicker/Steam.py

@@ -0,0 +1,54 @@
+import requests
+from steam.webapi import WebAPI
+from steam.steamid import SteamID
+import steampicker.utility as utility
+
+class Steam:
+    def __init__(self, apikey):
+        self.api = WebAPI(apikey)
+        # self.client = steamapi.SteamClient(https://steamcommunity.com/id/mysteamidhere/home/)
+
+    def validateWebApiKey(apikey):
+        WebAPI(apikey)
+
+    def getSteamIdFromURL(profile_url):
+        return SteamID.from_url(profile_url)
+
+    def getOwnedGames(self, steamid):
+        response = self.api.IPlayerService.GetOwnedGames(
+            steamid                   = steamid,
+            include_appinfo           = True,
+            include_played_free_games = True,
+            appids_filter             = None,
+            include_free_sub          = True,
+            language                  = "en",
+            include_extended_appinfo  = True,
+            include_family_licenses   = False,
+            include_all_free_games    = False
+        )
+        return response['response']['games']
+
+    def getRawAppDetails(self, appid):
+        response = requests.get('http://store.steampowered.com/api/appdetails', params={'appids': appid})
+        apps = response.json()
+        app = apps[str(appid)]
+        return app['data'] if 'data' in app else None
+
+    def getAppDetails(self, appid):
+        raw_details = self.getRawAppDetails(appid)
+        if not raw_details:
+            return None
+
+        details = {}
+        if 'short_description' in raw_details and raw_details['short_description']:
+            details['Summary'] = utility.remove_html_tags(raw_details['short_description'])
+        if 'categories' in raw_details:
+            details['Categories'] = [category['description'] for category in raw_details['categories']]
+        if 'genres' in raw_details:
+            details['Genres'] = [genre['description'] for genre in raw_details['genres']]
+        if 'platforms' in raw_details:
+            platforms = raw_details['platforms']
+            details['Platforms'] = [platform  for platform in platforms if platforms[platform]]
+        if 'metacritic' in raw_details:
+            details['Metacritic'] = raw_details['metacritic']
+        return details

steam_picker-0.1.7/steampicker/__init__.py

@@ -0,0 +1,3 @@
+import steampicker.filters
+from steampicker.Steam import Steam
+import steampicker.utility

steam_picker-0.1.7/steampicker/filters.py

@@ -0,0 +1,61 @@
+'''
+Pre-made app filters for easy filtering.
+
+Feel free to customize!
+'''
+class Filter:
+    def __init__(self, text, lambda_filter):
+        self.text = text
+        self.function = lambda_filter
+
+# A list of quick filter aliases to apply by default.
+default = []
+
+# The available quick filters.
+quick = {
+    #TODO: 'aaa' and proper 'indie'. Doesn't seem possible with current metadata.
+    'coop': Filter(
+        'Co-op games.',
+        lambda x: any('Co-op' in category for category in x['Categories'])
+    ),
+    'indie': Filter(
+        'Indie games. (Some indie games are not tagged, so expect false negatives.)',
+        lambda x: 'Indie' in x['Genres']
+    ),
+    'linux': Filter(
+        'Linux support.',
+        lambda x: 'linux' in x['Platforms']
+    ),
+    'mac': Filter(
+        'MacOS support.',
+        lambda x: 'mac' in x['Platforms']
+    ),
+    'multi': Filter(
+        'Multi-player.',
+        lambda x: 'Multi-player' in x['Categories']
+    ),
+    'score': Filter(
+        'Metracritic scores >= 70. (Filters out games lacking Metacritic scores.)',
+        lambda x: x['Metacritic']['score'] >= 70
+    ),
+    'score80': Filter(
+        'Metracritic scores >= 80. (Filters out games lacking Metacritic scores.)',
+        lambda x: x['Metacritic']['score'] >= 80
+    ),
+    'score90': Filter(
+        'Metracritic scores >= 90. (Filters out games lacking Metacritic scores.)',
+        lambda x: x['Metacritic']['score'] >= 90
+    ),
+    'single': Filter(
+        'Single-player.',
+        lambda x: 'Single-player' in x['Categories']
+    ),
+    'vr': Filter(
+        'VR support. (Steam store metadata does not categorize all VR-capable games, so this will miss some.)',
+        lambda x: 'VR Support' in x['Categories']
+    ),
+    'unplayed': Filter(
+        'Played less than an hour.',
+        lambda x: x['Playtime']['hours'] == 0
+    ),
+}

steam_picker-0.1.7/steampicker/party_time.txt

@@ -0,0 +1,3 @@
+░▐█▀█ ▄▀▄ █▀▀▄ ▀█▀ ▀▄─▄▀──░█▀█▀█ ▀ █▄─▄█ █▀▀░█░█░█
+░▐█▄█ █▀█ █▐█▀ ─█─ ──█──────░█── █ █─█─█ █▀▀─▀─▀─▀
+░▐█── ▀─▀ ▀─▀▀ ─▀─ ──▀─────░▄█▄─ ▀ ▀───▀ ▀▀▀░▄░▄░▄

steam_picker-0.1.7/steampicker/steampicker.py

@@ -0,0 +1,110 @@
+#! /usr/bin/env python3
+from appdirs import AppDirs
+import argparse
+from importlib.metadata import PackageNotFoundError, version
+from importlib.resources import files
+from pathlib import Path
+import random
+
+from steampicker import filters, Steam, utility
+
+def get_version():
+    try:
+        return version('steam-picker')
+    except PackageNotFoundError:
+        return 'unknown'
+
+def run():
+    parser = argparse.ArgumentParser(description='Pick a random game from your personal Steam library!')
+    parser.add_argument('--version', action='version', version='%(prog)s ' + get_version())
+    parser.parse_args()
+
+    print('Pick a game from your personal Steam library!')
+
+    appdirs = AppDirs('steam-picker')
+    creds_path = Path(appdirs.user_config_dir).joinpath('creds.yaml')
+
+    party_time = files('steampicker').joinpath('party_time.txt').read_text(encoding='utf-8')
+    if type(party_time) is bytes:
+        party_time = party_time.decode()
+
+    creds = utility.load_steam_creds(creds_path)
+    steam = Steam(creds['apikey'])
+    owned_games = steam.getOwnedGames(creds['steamid'])
+
+    active_filters = []
+    exit_app = False
+
+    while not exit_app:
+        game = random.choice(owned_games)
+
+        if 'appid' not in game:
+            continue
+
+        details = steam.getAppDetails(game['appid']) or {}
+        details['Playtime'] = {'hours': game['playtime_forever'] // 60}
+        details['Steam URL'] = 'https://store.steampowered.com/app/{}/'.format(game['appid'])
+
+        if active_filters:
+            passed = True
+            for filter in active_filters:
+                try:
+                    passed = filter.function(details)
+                    if not passed:
+                        break
+                except KeyError:
+                    print("Could not apply filter '{}' on '{}'. Skipping.".format(filter.text, game['name']))
+                    passed = False
+                    break
+            if not passed:
+                continue
+
+        print("\nHow about... '{}'?\n".format(game['name']))
+        if details:
+            for detail, value in details.items():
+                print("{: <12}{}".format(*[detail + ':', value]))
+
+        answer = input('\n[y = accept, n or q = quit, f = filter, other = continue]: ').lower()
+
+        if 'y' in answer:
+            picked_game = game['name']
+            print("\nAlright, '%s' it is.\n" % picked_game)
+            print(party_time)
+
+            exit_app = True
+        elif 'f' in answer:
+            print('\nSee filters.py to customize quick filters and add default filters.')
+            if active_filters:
+                print('\nActive filters')
+                print('==============')
+                for i, active_filter in enumerate(active_filters):
+                    print("{:<12}'{}'".format("[{}]:".format(i), active_filter.text))
+            print('\nQuick filters')
+            print('=============')
+            for alias, quick_filter in filters.quick.items():
+                print("{:<12}{}".format("{}:".format(alias), quick_filter.text))
+
+            reply = input('\n[Quick filter aliases (space separated)\n<or> Python lambda x: filter body to add\n<or> filter ID to delete]: ')
+            if reply.isdigit():
+                filterid = int(reply)
+                try:
+                    del active_filters[filterid]
+                except Exception:
+                    print('Error: unable to delete that filter. Is the ID within range?')
+            elif reply.split(' ')[0].strip() in filters.quick:
+                aliases = [x.strip() for x in reply.split(' ')]
+                for alias in aliases:
+                    try:
+                        active_filters.append(filters.quick[alias])
+                    except Exception:
+                        print("Error: alias '{}' could not be applied.".format(alias))
+            else:
+                try:
+                    text = 'lambda x: ' + reply
+                    filter_lambda = eval(text)
+                    active_filters.append(filters.Filter(text, filter_lambda))
+                except Exception:
+                    print('Error: could not add filter. Please check expression.')
+        elif any(x in answer for x in ['n', 'q']):
+            print("\nAlrighty then, y'all come back now, ya hear?")
+            exit_app = True

steam_picker-0.1.7/steampicker/utility.py

@@ -0,0 +1,35 @@
+def load_steam_creds(path):
+    '''
+    Load Steam credentials from a YAML file, or create the file if none exists.
+
+    Args:
+        path: pathlib.Path to yaml file containing creds.
+
+    Returns:
+        A dict of Steam credentials.
+    '''
+    import os
+    import yaml
+    from steampicker.Steam import Steam
+
+    creds = None
+    if path.exists():
+        with open(path, 'r') as f:
+            creds = yaml.load(f, Loader=yaml.Loader)
+    else:
+        if not path.parent.exists():
+            os.makedirs(path.parent)
+        creds = {}
+        creds['profile_url'] = input('Please enter your Steam profile URL [e.g., https://steamcommunity.com/id/MyUserName/home/]: ')
+        creds['steamid'] = Steam.getSteamIdFromURL(creds['profile_url'])
+        creds['apikey'] = input('Please enter your Steam API access key (see https://steamcommunity.com/dev/apikey): ')
+        Steam.validateWebApiKey(creds['apikey'])
+        with open(path, 'w') as f:
+            yaml.dump(creds, f, default_flow_style=False)
+    return creds
+
+
+def remove_html_tags(text):
+    '''Remove HTML tags from a string.'''
+    import re
+    return re.sub('<[^<]+?>', '', text)