About

steamCLI is a command line tool that allows searching Steam for historic game/app prices straight from the command line. It supports recent and overall ratings, current prices on Steam, historical low price, different currencies and regions.

Installation

To use steamCLI, you need to have Python 3.6+. To check your version, issue the following command in the terminal:

python3 --version

Once you have a correct version of Python installed, enter the following command:

pip3.6 install steamcli

This will download and install steamCLI and its dependencies for Python 3.6. If you use pip install ..., however, it will most likely be installed for Python 2.7, since most major OSes rely on it in one way or the other. The app will not work on 2.7.

Once pip installs the app, you can already use it. However, you will not be able to access historical data (such as lowest prices). First, you need to get an API key for Is There Any Deal. You will need to register your app (steamCLI) and request an API key. You can do it here. Additional documentation is available here.

Export the key you have been given as environment variable:

export steamCLI=[your_API_key]

You can also set environment variable permanently:

• Mac
• Ubuntu

Now you should be able to use the full capacities of the app.

Usage

You can see what you can do with the script by calling:

steamcli -h

Currently, the following option are available:

-h,      --help            show this help message and exit
-t,      --title           title of a game or an app on Steam
-id val, --appid val       id of a game or an app on Steam
-d,      --description     include to see the app description
-s,      --scores          include to see user review scores
-r val,  --region val      which region the price should be shown for Available
                           values: au, br, ca, cn, eu1, eu2, ru, tr, uk, us
-l,      --historical_low  include to see historical low price

For example, if you wanted to find out release date, price, discount and metacritic reviews for Borderlands, you'd simply have to call

steamcli -t

and enter borderlands (title is case-insensitive). Example output:

                   *** Borderlands (26 Oct, 2009) ***                      
                      9.99 GBP (0% from 9.99 GBP)                          
                          Metacritic score: 81 

Tests

If you have cloned the repository, you can run the tests from the Terminal. To do so, navigate to the root folder of steamCLI app and issue the following command:

python -m unittest discover

Cloning the and Setting Up the Project

1. Ensure you have Python 3.6+ installed:

python3 --version

2. Clone the project:

git clone git@github.com:vilisimo/steamCLI.git

3. (Recommended) Ensure virtualenvwrapper is installed:

pip list | grep virtualenvwrapper

• If it is not installed, enter:

pip install virtualenvwrapper

4. (Recommended) Create virtual environment for the project:

mkvirtualenv -p python3.6 steamCLI

5. Install required packages in requirements.txt:

pip install -r requirements.txt`

6. Update a PYTHONPATH environment variable:

PYTHONPATH=$PYTHONPATH:/path/to/root/folder

• If you're using virtualenvwrapper, you can write:

add2virtualenv /path/to/root/folder

7. Get an API key for Is There Any Deal (if you want to see the historical low price). For that, you need register your app and request an API key. You can do it here. Additional documentation is available here.

8. Export the key as environment variable:

export steamCLI=[your_API_key]

• You can also set environment variable permanently:
  • Mac
  • Ubuntu