summaryrefslogtreecommitdiff
path: root/README.md
blob: 9cb5619abcfae089810724a88900d62a6f0a7639 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Steam Relationships

## A tool to discover friend relationships between steam profiles

Ever ran into a cheater, looked at their profile, and realized all their friends are cheaters too? I have, and this tool is a way to measure degrees of separation from a specific individual

Steam Relationships querries the Steam WebAPI to get public friends lists, and then recursively search those friend lists as well. This process repeats until a certain number of "degrees" have been met (a set recursion level specified by the user). The results of these querries are put in a database that can then be shared and used for other purposes

## REQUIREMENTS

1. A [Steam Developer API key](https://steamcommunity.com/dev/apikey)
2. [Poetry](https://python-poetry.org/)

## INSTALLATION

1. Clone the repo
2. [Install poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) (if poetry isn't already installed)
3. Open a `poetry shell`
4. Run `poetry install`

```bash
git clone https://git.dabikers.online/SteamRelationships && cd SteamRelationships

poetry shell && poetry install
```