https://github.com/helldivers-2/diveharder_api.py

A Python FastAPI proxy providing endpoints to access Helldivers 2 API data for community developers
https://github.com/helldivers-2/diveharder_api.py

api community diveharder fastapi games helldivers-2 helldivers2 json managed-democracy openapi proxy-api python redoc rest rest-api reverse-engineering swagger unofficial-api unofficial-apis

Last synced: 28 days ago
JSON representation

A Python FastAPI proxy providing endpoints to access Helldivers 2 API data for community developers

• Host: GitHub
• URL: https://github.com/helldivers-2/diveharder_api.py
• Owner: helldivers-2
• License: agpl-3.0
• Created: 2024-03-26T18:34:43.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-10T02:51:11.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T04:43:22.130Z (almost 2 years ago)
• Topics: api, community, diveharder, fastapi, games, helldivers-2, helldivers2, json, managed-democracy, openapi, proxy-api, python, redoc, rest, rest-api, reverse-engineering, swagger, unofficial-api, unofficial-apis
• Language: Python
• Homepage: https://api.diveharder.com
• Size: 116 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org/)

[![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)](https://fastapi.tiangolo.com/)[![Python Black](https://img.shields.io/badge/Python%20Black-000000?style=for-the-badge&logo=python&logoColor=FFFFFF&labelColor=000000&color=000000)](https://github.com/psf/black)

A proxy API providing endpoints to access Helldivers 2 API data




Project Setup

Environment Setup

For a sanitary environment, dev work should be done inside a [Virtual Environment](https://docs.python.org/3/library/venv.html)


```shell

python -m pip install --user --upgrade pip

python -m pip install --user virtualenv

python -m venv venv

# Windows

./venv/Scripts/activate

# Linux/MacOS

source ./venv/bin/activate

pip install -r ./requirements.txt

```

Project .env Setup


In ./src/cfg/env you can find a .env.example


This can be renamed to .env and used as is, and it will use api.diveharder.com


Or you may change the links to the AHGS API endpoints if you have them.

SECURITY_TOKEN is what you use to access the /admin/* endpoints 


SESSION_TOKEN is for accessing AHGS APIs that require authentication

Local Deployment

```shell

docker build -t myappimage .

docker run --name myappname -p 1234:1234 myappimage

```

You are now fully setup, and can access your project at:

```http

localhost:1234

localhost:1234/docs

```

Acknowledgements

[@dealloc](https://github.com/dealloc/), [@lambstream](https://github.com/lambstream) , and the [@helldivers-2](https://github.com/helldivers-2/) organization