<div id="top"></div>
<!-- PROJECT SHIELDS -->
[](https://pypi.org/project/steam-market-history/)
[](https://pypi.org/project/steam-market-history/)
[](https://gitlab.com/sustineo/steam-market-history/-/pipelines)
[](https://gitlab.com/sustineo/steam-market-history/-/issues)
[](https://gitlab.com/sustineo/steam-market-history/-/merge_requests)
[](https://gitlab.com/sustineo/steam-market-history/-/blob/main/LICENSE)
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://gitlab.com/sustineo/steam-market-history">
<img src="https://gitlab.com/sustineo/steam-market-history/-/raw/main/docs/images/logo.svg" alt="Logo" width="120" height="120">
</a>
<h3 align="center">steam-market-history</h3>
<p align="center">
An easy-to-use CLI to export your steam market history to various formats
<br />
<a href="https://gitlab.com/sustineo/steam-market-history/-/raw/main/docs/demo.gif">View Demo</a>
·
<a href="https://gitlab.com/sustineo/steam-market-history/-/issues">Report Bug</a>
·
<a href="https://gitlab.com/sustineo/steam-market-history/-/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
steam-market-history is a command line tool written in Python which allows you to extract your entire Steam Market History with all transaction (sales/purchases) in a CSV or HTML file.
### Key features
- Extract your **entire** Steam Market History with all transactions to a HTML, CSV or JSON file
- Overview of _all_ transactions on a user-friendly webpage with searchable and filterable results
### Built With
- [Python](https://www.python.org/)
- [Typer](https://typer.tiangolo.com/)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Python >= 3.8
### Installation
Pip (recommended):
```shell
pip install steam-market-history
```
Manual:
1. Clone the repo
```sh
git clone https://gitlab.com/sustineo/steam-market-history.git
```
2. Install poetry (if not already installed)
```sh
pip install poetry
```
3. Install dependencies and start virtual environment
```sh
poetry install && poetry shell
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
Currently, the following commands are supported:
### `export`
Export your steam market history to an HTML, JSON or CSV file
> When running the tool you will be prompted to insert your steam credentials. All processing is done locally on your computer. This package does not save your credentials in any way.
Options:
- `--csv` - Export market transactions to csv file
- `--html` - Export market transactions to html file
- `--json` - Export market transactions to json file
- `--path` - Output directory for all file based operations (default: current working directory)
- `--launch` / `--no-launch` - Automatically open file(s) after export (default: `--launch`)
- `--cache` / `--no-cache` - Create a file cache for all market transactions (default: `--no-cache`)
- `--interactive` / `--non-interactive` - Interactive or non-interactive steam authentication [default: `--interactive`]
Examples:
Export your steam market history to a HTML file:
```shell
steam-market-history export --html
```
Export your steam market history to a CSV file in a specific directory:
```shell
steam-market-history export --csv --path /tmp/steam-market-history
```
### `version`
Display detailed information about this package. This includes the version, the license and the authors.
```
steam-market-history version
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
- [ ] Add options of verbosity
See the [open issues](https://gitlab.com/sustineo/steam-market-history/-/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
## Acknowledgments
- [Typer](https://typer.tiangolo.com/)
- [Choose a license](https://choosealicense.com/)
<p align="right">(<a href="#top">back to top</a>)</p>
## Disclaimer:
The Steam Market History Exported is a community project and is not affiliated with Valve or Steam.
<p align="right">(<a href="#top">back to top</a>)</p>
Raw data
{
"_id": null,
"home_page": "https://github.com/fabieu/steam-market-history",
"name": "steam-market-history",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "steam,CLI",
"author": "Fabian Eulitz",
"author_email": "dev@sustineo.de",
"download_url": "https://files.pythonhosted.org/packages/c9/1d/b39df295465d9f786ec87209314b0c96d75879a5ca4a7590c89bb6e71f44/steam_market_history-3.1.0.tar.gz",
"platform": null,
"description": "<div id=\"top\"></div>\n\n<!-- PROJECT SHIELDS -->\n\n[](https://pypi.org/project/steam-market-history/)\n[](https://pypi.org/project/steam-market-history/)\n[](https://gitlab.com/sustineo/steam-market-history/-/pipelines)\n[](https://gitlab.com/sustineo/steam-market-history/-/issues)\n[](https://gitlab.com/sustineo/steam-market-history/-/merge_requests)\n[](https://gitlab.com/sustineo/steam-market-history/-/blob/main/LICENSE)\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <a href=\"https://gitlab.com/sustineo/steam-market-history\">\n <img src=\"https://gitlab.com/sustineo/steam-market-history/-/raw/main/docs/images/logo.svg\" alt=\"Logo\" width=\"120\" height=\"120\">\n </a>\n\n<h3 align=\"center\">steam-market-history</h3>\n\n <p align=\"center\">\n An easy-to-use CLI to export your steam market history to various formats\n <br />\n <a href=\"https://gitlab.com/sustineo/steam-market-history/-/raw/main/docs/demo.gif\">View Demo</a>\n \u00b7\n <a href=\"https://gitlab.com/sustineo/steam-market-history/-/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://gitlab.com/sustineo/steam-market-history/-/issues\">Request Feature</a>\n </p>\n</div>\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a></li>\n <li><a href=\"#roadmap\">Roadmap</a></li>\n <li><a href=\"#contributing\">Contributing</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n<!-- ABOUT THE PROJECT -->\n\n## About The Project\n\nsteam-market-history is a command line tool written in Python which allows you to extract your entire Steam Market History with all transaction (sales/purchases) in a CSV or HTML file.\n\n### Key features\n\n- Extract your **entire** Steam Market History with all transactions to a HTML, CSV or JSON file\n- Overview of _all_ transactions on a user-friendly webpage with searchable and filterable results\n\n### Built With\n\n- [Python](https://www.python.org/)\n- [Typer](https://typer.tiangolo.com/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- GETTING STARTED -->\n\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\n- Python >= 3.8\n\n### Installation\n\nPip (recommended):\n\n```shell\npip install steam-market-history\n```\n\nManual:\n\n1. Clone the repo\n ```sh\n git clone https://gitlab.com/sustineo/steam-market-history.git\n ```\n2. Install poetry (if not already installed)\n ```sh\n pip install poetry\n ```\n3. Install dependencies and start virtual environment\n ```sh\n poetry install && poetry shell\n ```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- USAGE EXAMPLES -->\n\n## Usage\n\nCurrently, the following commands are supported:\n\n### `export`\n\nExport your steam market history to an HTML, JSON or CSV file\n\n> When running the tool you will be prompted to insert your steam credentials. All processing is done locally on your computer. This package does not save your credentials in any way.\n\nOptions:\n\n- `--csv` - Export market transactions to csv file\n- `--html` - Export market transactions to html file\n- `--json` - Export market transactions to json file\n- `--path` - Output directory for all file based operations (default: current working directory)\n- `--launch` / `--no-launch` - Automatically open file(s) after export (default: `--launch`)\n- `--cache` / `--no-cache` - Create a file cache for all market transactions (default: `--no-cache`)\n- `--interactive` / `--non-interactive` - Interactive or non-interactive steam authentication [default: `--interactive`]\n\nExamples:\n\nExport your steam market history to a HTML file:\n```shell\nsteam-market-history export --html\n```\n\nExport your steam market history to a CSV file in a specific directory:\n```shell\nsteam-market-history export --csv --path /tmp/steam-market-history\n```\n\n### `version`\n\nDisplay detailed information about this package. This includes the version, the license and the authors.\n\n```\nsteam-market-history version\n```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- ROADMAP -->\n\n## Roadmap\n\n- [ ] Add options of verbosity\n\nSee the [open issues](https://gitlab.com/sustineo/steam-market-history/-/issues) for a full list of proposed features (and known issues).\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- CONTRIBUTING -->\n\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- LICENSE -->\n\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- ACKNOWLEDGMENTS -->\n\n## Acknowledgments\n\n- [Typer](https://typer.tiangolo.com/)\n- [Choose a license](https://choosealicense.com/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n## Disclaimer:\n\nThe Steam Market History Exported is a community project and is not affiliated with Valve or Steam.\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An easy-to-use CLI to export your steam market history to various formats",
"version": "3.1.0",
"split_keywords": [
"steam",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2579fe91fbed5cb197203e00e81d0cf4802f87eda5fd54c166254ffe41b28628",
"md5": "326e853635d89cbf20eef1e01b917dd4",
"sha256": "a59e994f2db8354853504d97cd45c53d34f9821c22e5ca83f73823d83ae2f6bd"
},
"downloads": -1,
"filename": "steam_market_history-3.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "326e853635d89cbf20eef1e01b917dd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 10457,
"upload_time": "2023-04-18T20:50:02",
"upload_time_iso_8601": "2023-04-18T20:50:02.064126Z",
"url": "https://files.pythonhosted.org/packages/25/79/fe91fbed5cb197203e00e81d0cf4802f87eda5fd54c166254ffe41b28628/steam_market_history-3.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c91db39df295465d9f786ec87209314b0c96d75879a5ca4a7590c89bb6e71f44",
"md5": "7f3588a7d6263e58ae0a28721346e655",
"sha256": "97520df035f0394c3fa09efbf44a8832ac2d8224d57bd26dc5ba7c37b3f26a43"
},
"downloads": -1,
"filename": "steam_market_history-3.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7f3588a7d6263e58ae0a28721346e655",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 10185,
"upload_time": "2023-04-18T20:50:03",
"upload_time_iso_8601": "2023-04-18T20:50:03.656793Z",
"url": "https://files.pythonhosted.org/packages/c9/1d/b39df295465d9f786ec87209314b0c96d75879a5ca4a7590c89bb6e71f44/steam_market_history-3.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-18 20:50:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fabieu",
"github_project": "steam-market-history",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "steam-market-history"
}
JSON
