# Vapor: Steam Proton Compatibility Checker
<p align="center">
<a href="https://badge.fury.io/py/vapor-steam"><img alt="PyPI" src="https://img.shields.io/pypi/v/vapor-steam" /></a>
<a href="https://aur.archlinux.org/packages/python-vapor-steam/"><img alt="AUR version" src="https://img.shields.io/aur/version/python-vapor-steam"></a>
<a href="https://pepy.tech/project/vapor-steam"><img alt="Downloads" src="https://pepy.tech/badge/vapor-steam" /></a>
<a href="https://github.com/TabulateJarl8/vapor/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/pypi/l/vapor-steam.svg" /></a>
<a href="https://github.com/TabulateJarl8/vapor/graphs/commit-activity"><img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
<a href="https://github.com/TabulateJarl8/vapor/issues/"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/TabulateJarl8/vapor.svg" /></a>
<img alt="Coverage" src="https://img.shields.io/codecov/c/github/TabulateJarl8/vapor" />
<a href="https://github.com/TabulateJarl8"><img alt="GitHub followers" src="https://img.shields.io/github/followers/TabulateJarl8?style=social" /></a>
<br>
<a href="https://ko-fi.com/L4L3L7IO2"><img alt="Kofi Badge" src="https://ko-fi.com/img/githubbutton_sm.svg" /></a>
</p>
Vapor is a Python package built on [Textual](https://github.com/textualize/textual/) which offers a simple Terminal User Interface for checking ProtonDB compatibility ratings of games in a Steam user's library. The tool seamlessly integrates Steam and ProtonDB APIs to provide insightful compatibility information.
## Installation
[pipx](https://pipx.pypa.io/stable/) is a great tool for installing Python packages in an isolated environment. If wanting to install via `pipx`, just run
```shell
pipx install vapor-steam
```
This project can also be installed with pip normally with
```shell
pip3 install vapor-steam
```
Arch users can install the package from the AUR with your favorite AUR helper:
```shell
paru -S python-vapor-steam
```
Or manually with `makepkg`:
```shell
git clone https://aur.archlinux.org/python-vapor-steam.git && cd python-vapor-steam
makepkg -si
```
## Quick Start
1. **Obtain a Steam API Key**: Get your Steam API key by [filling out this form](https://steamcommunity.com/dev/apikey).
2. **Run the Program**: Run vapor with the `vapor` command. It can also be ran without installation, with `python3 vapor/main.py`.
## Features
- **User Library Analysis**: Fetches and displays game compatibility ratings from ProtonDB for a specified Steam user.
- **User Average Compatibility**: Calculates and presents the average game compatibility for the user's library.
- **Automatic Steam ID Resolution**: Vapor automatically resolves the given Steam ID, so you can use either your vanity name or your 64-bit Steam ID.
- **Automatic Steam URL Detection**: Directly paste a Steam user profile URL, like `https://steamcommunity.com/id/<user>` or `https://steamcommunity.com/profiles/<user>` into the "User ID" box and it will be detected and parsed correctly.
- **AreWeAntiCheatYet Integration**: Integartion with Are We Anti-Cheat Yet? to show the anti-cheat compatibility status of your games.
## Requirements
This package is built on top of textual and aiohttp, and uses poetry to manage dependencies. To install dependencies locally, just run `poetry install` in the repository's directory.
## Private Steam Account Error
This error occurs if your game details are set to private in your privacy settings. First, double check that you're using the correct Steam ID or vanity URL. This is different from your display name. To make sure, you can directly copy your profile URL into Vapor and your Steam ID will be extracted. Your profile URL will look like `https://steamcommunity.com/id/<vanity_name>` or `https://steamcommunity.com/profiles/<steam_id>`.
If you've double checked that your account information is correct, please complete the following steps to fix this issue:
1. From Steam, click the user dropdown and select "View my profile"
1. Click the "Edit Profile" button
2. Click the "Privacy Settings" tab
3. Set "Game details" to Public
4. Uncheck the Always keep my total playtime private option
## Contributing
Contributions are welcomed! For bug fixes, improvements, or feature requests, feel free to open an issue or pull request.
Raw data
{
"_id": null,
"home_page": "https://tabulate.tech/software/vapor",
"name": "vapor-steam",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "steam, protondb, compatibility, textual, tui",
"author": "TabulateJarl8",
"author_email": "tabulatejarl8@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/f0/09746d54ce09e1d87b1f4b10eb9d2e85a19ec4c0318d000b8ee2e0d75571/vapor_steam-1.5.5.tar.gz",
"platform": null,
"description": "# Vapor: Steam Proton Compatibility Checker\n\n<p align=\"center\">\n\t<a href=\"https://badge.fury.io/py/vapor-steam\"><img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/vapor-steam\" /></a>\n\t<a href=\"https://aur.archlinux.org/packages/python-vapor-steam/\"><img alt=\"AUR version\" src=\"https://img.shields.io/aur/version/python-vapor-steam\"></a>\n\t<a href=\"https://pepy.tech/project/vapor-steam\"><img alt=\"Downloads\" src=\"https://pepy.tech/badge/vapor-steam\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8/vapor/blob/master/LICENSE\"><img alt=\"License\" src=\"https://img.shields.io/pypi/l/vapor-steam.svg\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8/vapor/graphs/commit-activity\"><img alt=\"Maintenance\" src=\"https://img.shields.io/badge/Maintained%3F-yes-green.svg\" /></a>\n\t<a href=\"https://github.com/TabulateJarl8/vapor/issues/\"><img alt=\"GitHub Issues\" src=\"https://img.shields.io/github/issues/TabulateJarl8/vapor.svg\" /></a>\n\t<img alt=\"Coverage\" src=\"https://img.shields.io/codecov/c/github/TabulateJarl8/vapor\" />\n\t<a href=\"https://github.com/TabulateJarl8\"><img alt=\"GitHub followers\" src=\"https://img.shields.io/github/followers/TabulateJarl8?style=social\" /></a>\n\t<br>\n\t<a href=\"https://ko-fi.com/L4L3L7IO2\"><img alt=\"Kofi Badge\" src=\"https://ko-fi.com/img/githubbutton_sm.svg\" /></a>\n</p>\n\nVapor is a Python package built on [Textual](https://github.com/textualize/textual/) which offers a simple Terminal User Interface for checking ProtonDB compatibility ratings of games in a Steam user's library. The tool seamlessly integrates Steam and ProtonDB APIs to provide insightful compatibility information.\n\n\n\n## Installation\n[pipx](https://pipx.pypa.io/stable/) is a great tool for installing Python packages in an isolated environment. If wanting to install via `pipx`, just run\n```shell\npipx install vapor-steam\n```\nThis project can also be installed with pip normally with\n```shell\npip3 install vapor-steam\n```\n\nArch users can install the package from the AUR with your favorite AUR helper:\n```shell\nparu -S python-vapor-steam\n```\nOr manually with `makepkg`:\n```shell\ngit clone https://aur.archlinux.org/python-vapor-steam.git && cd python-vapor-steam\nmakepkg -si\n```\n\n## Quick Start\n1. **Obtain a Steam API Key**: Get your Steam API key by [filling out this form](https://steamcommunity.com/dev/apikey).\n2. **Run the Program**: Run vapor with the `vapor` command. It can also be ran without installation, with `python3 vapor/main.py`.\n\n## Features\n - **User Library Analysis**: Fetches and displays game compatibility ratings from ProtonDB for a specified Steam user.\n - **User Average Compatibility**: Calculates and presents the average game compatibility for the user's library.\n - **Automatic Steam ID Resolution**: Vapor automatically resolves the given Steam ID, so you can use either your vanity name or your 64-bit Steam ID.\n - **Automatic Steam URL Detection**: Directly paste a Steam user profile URL, like `https://steamcommunity.com/id/<user>` or `https://steamcommunity.com/profiles/<user>` into the \"User ID\" box and it will be detected and parsed correctly.\n - **AreWeAntiCheatYet Integration**: Integartion with Are We Anti-Cheat Yet? to show the anti-cheat compatibility status of your games.\n\n## Requirements\nThis package is built on top of textual and aiohttp, and uses poetry to manage dependencies. To install dependencies locally, just run `poetry install` in the repository's directory.\n\n## Private Steam Account Error\nThis error occurs if your game details are set to private in your privacy settings. First, double check that you're using the correct Steam ID or vanity URL. This is different from your display name. To make sure, you can directly copy your profile URL into Vapor and your Steam ID will be extracted. Your profile URL will look like `https://steamcommunity.com/id/<vanity_name>` or `https://steamcommunity.com/profiles/<steam_id>`.\n\nIf you've double checked that your account information is correct, please complete the following steps to fix this issue:\n\n1. From Steam, click the user dropdown and select \"View my profile\"\n1. Click the \"Edit Profile\" button\n2. Click the \"Privacy Settings\" tab\n3. Set \"Game details\" to Public\n4. Uncheck the Always keep my total playtime private option\n\n## Contributing\nContributions are welcomed! For bug fixes, improvements, or feature requests, feel free to open an issue or pull request.\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "TUI program to check the ProtonDB compatibility of all the games of a Steam user.",
"version": "1.5.5",
"project_urls": {
"Homepage": "https://tabulate.tech/software/vapor",
"Repository": "https://github.com/TabulateJarl8/vapor"
},
"split_keywords": [
"steam",
" protondb",
" compatibility",
" textual",
" tui"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9468280248641a8cfae70cff6e65197d4d32e9a423d10d62596481b23cc23e57",
"md5": "91191cb59df34f6fc950ca460dd2fc80",
"sha256": "5723fed2cd856806a3a34df7eccdd88946a37de3e3a0db6353f94485946d3620"
},
"downloads": -1,
"filename": "vapor_steam-1.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "91191cb59df34f6fc950ca460dd2fc80",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 26299,
"upload_time": "2024-04-29T23:54:54",
"upload_time_iso_8601": "2024-04-29T23:54:54.693503Z",
"url": "https://files.pythonhosted.org/packages/94/68/280248641a8cfae70cff6e65197d4d32e9a423d10d62596481b23cc23e57/vapor_steam-1.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38f009746d54ce09e1d87b1f4b10eb9d2e85a19ec4c0318d000b8ee2e0d75571",
"md5": "9897a4c15c8bdbed63a816b26eb1dc8d",
"sha256": "eaae5a3f08c1b124dd005376e4eb17b8ffdb35b93ce9097af39f34c8474a3854"
},
"downloads": -1,
"filename": "vapor_steam-1.5.5.tar.gz",
"has_sig": false,
"md5_digest": "9897a4c15c8bdbed63a816b26eb1dc8d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 30070,
"upload_time": "2024-04-29T23:54:57",
"upload_time_iso_8601": "2024-04-29T23:54:57.339316Z",
"url": "https://files.pythonhosted.org/packages/38/f0/09746d54ce09e1d87b1f4b10eb9d2e85a19ec4c0318d000b8ee2e0d75571/vapor_steam-1.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-29 23:54:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TabulateJarl8",
"github_project": "vapor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vapor-steam"
}
JSON
