Skip to content
Open
13 changes: 13 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Python
*.pyc
.venv/
__pycache__/

# macOS
.DS_Store
.Spotlight-V100
.Trashes

# VS Code
.vscode/
.editorconfig
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# Contributing
## Install depedencies
To contribute to this project, you will need to install both the user and dev requirements
```
pip install -r requirements.txt
pip install -r requirements-dev.txt
```

## Update requirement files
To update the user dependencies:
```
pip-compile requirements.in
```

To update the dev requirements:
```
pip-compile requirements-dev.in
```
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
## Status
This library is currently a work in progress, endpoint and test coverage can be found below:

ℹ️  Endpoint coverage: 8 of 30
ℹ️  Test coverage: 0 of 30
ℹ️  Endpoint coverage: 42 of 42
ℹ️  Test coverage: 0 of 42

## Features

Expand Down Expand Up @@ -53,10 +53,9 @@ To use any endpoint function in the API, you must first be authorized by RetroAc
```python
from retroachievements import RAClient

userName = '<your username on RA>'
webApiKey = '<your web API key>'
web_api_key = '<your web API key>'

auth = RAClient(userName, webApiKey)
client = RAClient(web_api_key)
```

4. You now have all you need to use any function in the API. Each function takes this authorization object as its first argument. Here's an example:
Expand All @@ -66,7 +65,7 @@ from retroachievements import getGame

// This returns basic metadata about the game on this page:
// https://retroachievements.org/game/14402
game = auth.getGame(14402);
game = client.getGame(14402);
```

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Security Policy

The RAWeb team takes the security of the RetroAchievements platform seriously. If you discover a security issue, we appreciate your help in disclosing it to us in a responsible manner.
The RAWeb team takes the security of the RetroAchievements platform seriously. If you discover a security issue, we would appreciate your help in disclosing it to us in a responsible manner.

## Reporting a Vulnerability

Expand Down
2 changes: 2 additions & 0 deletions requirements-dev.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
black==25.1.0
pip-tools==7.4.1
36 changes: 36 additions & 0 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#
# This file is autogenerated by pip-compile with Python 3.12
# by the following command:
#
# pip-compile requirements-dev.in
#
black==25.1.0
# via -r requirements-dev.in
build==1.2.2.post1
# via pip-tools
click==8.2.1
# via
# black
# pip-tools
mypy-extensions==1.1.0
# via black
packaging==25.0
# via
# black
# build
pathspec==0.12.1
# via black
pip-tools==7.4.1
# via -r requirements-dev.in
platformdirs==4.3.8
# via black
pyproject-hooks==1.2.0
# via
# build
# pip-tools
wheel==0.45.1
# via pip-tools

# The following packages are considered to be unsafe in a requirements file:
# pip
# setuptools
1 change: 1 addition & 0 deletions requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
requests==2.32.3
16 changes: 16 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#
# This file is autogenerated by pip-compile with Python 3.12
# by the following command:
#
# pip-compile requirements.in
#
certifi==2025.6.15
# via requests
charset-normalizer==3.3.2
# via requests
idna==3.7
# via requests
requests==2.32.3
# via -r requirements.in
urllib3==2.2.2
# via requests
Loading