foxapi 1.8.1
A wrapper for the foxhole API
License: MIT
Keywords: foxhole, foxapi, foxhole-game, foxhole-api

# FoxAPI Documentation

### Join our discord : https://discord.gg/XJJkuDYZXw

## Installation
```bash
pip install foxapi
```


`FoxAPI` is a wrapper for the Official Foxhole API. It provides methods to interact with various endpoints related to maps, war data, dynamic/static map states, and more. The client supports data caching and etags natively to avoid overloading the Foxhole servers.

If you are new to the developer world (or lazy like me), it's the perfect tool!

Also, if you work with discord.py or any asynchronous API, this tool might be useful as well since it support async methods natively as well as synchronous


## Table of Contents
- [FoxAPI Documentation](#foxapi-documentation)
    - [Join our discord : https://discord.gg/XJJkuDYZXw](#join-our-discord--httpsdiscordggxjjkudyzxw)
  - [Installation](#installation)
  - [Table of Contents](#table-of-contents)
  - [Dependencies](#dependencies)
  - [Wrapper](#wrapper)
  - [Methods](#methods)
    - [API Interaction (async)](#api-interaction-async)
      - [Note : all of theses methods are async, to run the synchronous version, add \_sync at the end (see API example)](#note--all-of-theses-methods-are-async-to-run-the-synchronous-version-add-_sync-at-the-end-see-api-example)
    - [Map and War Data](#map-and-war-data)
    - [Hexagon Operations](#hexagon-operations)
    - [Listener Functions](#listener-functions)
    - [Queue Tasks](#queue-tasks)
  - [Error Handling](#error-handling)
  - [Objects](#objects)
  - [Example Usage](#example-usage)
    - [I am not responsible for what you are doing with it](#i-am-not-responsible-for-what-you-are-doing-with-it)


## Dependencies

   ```bash
   pip install pillow requests aiohttp
   ```

## Wrapper

```py
class FoxAPI(shard: str = "", image_dir: str = None, safe_mode: bool = True)
```


## Methods

### API Interaction (async)

#### Note : all of theses methods are async, to run the synchronous version, add _sync at the end (see API example)

```py
get_data(endpoint: str, etag: str = None, use_cache: bool = False) -> APIResponse
```  
  Fetches data from the specified endpoint, you can choose to use cache instead of sending a request and you can pass ETag.

  - Parameters:
    - `endpoint` (str): The API endpoint to call.
    - `etag` (str, optional): The ETag header for cache validation (not required since managed natively).
    - `use_cache` (bool, optional): Whether to use cached data (default: False).

  - Returns: The response data from the API as a APIResponse object.

### Map and War Data

```py
get_maps(use_cache: bool = True, session: aiohttp.ClientSession | None = None) -> list
```
 - Retrieves a list of available hexagons (maps) in the game world.

```py
get_war(use_cache: bool = False, session: aiohttp.ClientSession | None = None) -> dict
```
  - Retrieves the current war state (war data).

```py
get_static(hexagon: str, use_cache: bool = False, session: aiohttp.ClientSession | None = None) -> dict
```

  - Retrieves the static data for the specified hexagon.

```py
get_dynamic(hexagon: str, use_cache: bool = False, session: aiohttp.ClientSession | None = None) -> dict
```
  - Retrieves the dynamic data for the specified hexagon.

```py
get_war_report(hexagon: str, use_cache: bool = False, session: aiohttp.ClientSession | None = None) -> dict
```
  - Retrieves the war report for the specified hexagon.

```py
get_hexagon_data(hexagon: str, use_cache: bool = False, session: aiohttp.ClientSession | None = None) -> HexagonObject
```

  - Retrieves all the data awailable for the specified hexagon.

### Hexagon Operations

```py
calc_distance(x1: float, y1: float, x2: float, y2: float) -> float
```

  - Calculates the Euclidean distance between two points on the map.

```py
get_captured_towns(hexagon: str = None, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> dict
```
  - Retrieves the captured towns for a given hexagon based on dynamic and static data.

```py
load_hexagon_map(hexagon: str) -> pillow.Image
```

 - Loads the PNG map for the specified hexagon.

```py
make_map_png(hexagon: str, icons: str | list = "all", colored: bool = False, dynamic: dict = None, static: dict = None, session: aiohttp.ClientSession | None = None) -> pillow.Image
```
  - Generates a PNG image of the hexagon map with all the icons associated to each faction in their respective colors (included fields and town base). Only public data will be present.
  - colored -> display each region in the team's color
  - icons -> display selected building in their team's color

```py
calculate_death_rate(hexagon: str = None, war_report: dict = None, session: aiohttp.ClientSession | None = None): -> dict
```
  - calculate the death rate between the first launch and the current one

### Listener Functions

```py
on_api_update(callback: callable = None, endpoints: list = None)
```
  - Registers a callback function to be called when the data for specified API endpoints is updated.

```py
on_hexagon_update(callback: callable = None, hexagons: list = "all")
```
  - Registers a callback function to be called when the data for specified hexagons is updated.


### Queue Tasks

This library also give the possibility to queue up some sync and async methods to run them simultaneously

```py
from foxapi import FoxAPI

api = FoxAPI()

for i in range(10):
    api.add_task(function=api.get_war) # or any other method

data = api.run_task_sync()

for elem in data:
    print(elem.result)
```

```py
from foxapi import FoxAPI
import asyncio

api = FoxAPI()

async def main():
    for i in range(10):
        api.add_task(function=api.get_war) # or any other method

    data = await api.run_task()

    for elem in data:
        print(elem.result)

asyncio.run(main())
```

## Error Handling

```EndpointError```: Raised if an invalid API endpoint is used.

```HexagonError```: Raised if an invalid hexagon is provided.

```FoxAPIError```: A general error for issues within the FoxAPI class (e.g., missing data).


## Objects

```python
class Task:
    def __init__(self, function: callable, args: any = "no_args", result: any = None):
        self.function: callable = function
        self.args: any = args
        self.result: any = result


class APIResponse:
    def __init__(self, headers: dict, json: dict, status_code: int, hexagon: str, is_use_cache: bool):
        self.headers: dict = headers
        self.json: dict = json
        self.status_code: int = status_code
        self.hexagon: str = hexagon
        self.is_cache: bool = is_cache


class HexagonObject:
    def __init__(self, hexagon: str, war_report: dict, static: dict, dynamic: dict, captured_towns: dict, casualty_rate: dict):
        self.hexagon: str = hexagon
        self.war_report: dict = war_report
        self.static: dict = static
        self.dynamic: dict = dynamic
        self.captured_towns: dict = captured_towns
        self.casualty_rate: dict = casualty_rate
```


## Example Usage

```python
from foxapi import FoxAPI

# Initialize the API client in safe mode

# if you are a developer and plane to use the exact hexagons name
# you can turn the safe_mode off, otherwise it will convert
# api calls and hexagons name into valid ones
# Ex: deadlands -> DeadLandsHex (Yes, I am *that* lazy)

fox = FoxAPI(shard="1")


def function(hexagon: str = "DeadLandsHex"):
    # Get the list of available hexagons (maps) and state of the current war
    maps: list = fox.get_maps_sync()
    war: dict = fox.get_war_sync()

    # Retrieve data for a specific hexagon
    dynamic_data: dict = fox.get_dynamic_sync(hexagon)
    static_data: dict = fox.get_static_sync(hexagon)
    war_report: dict = fox.get_war_report_sync(hexagon)

    # Create a map PNG for a hexagon with building informations on it
    map_image = fox.make_map_png_sync(hexagon)
    map_image.show()

    # to get all the data at once

    data: HexagonObject = fox.get_hexagon_data_sync(hexagon=hexagon, use_cache=True)

# Async equivalent

async def function(hexagon: str = "DeadLandsHex"):
    # Get the list of available hexagons (maps) and state of the current war
    maps: list = await fox.get_maps()
    war: dict = await fox.get_war()

    # Retrieve data for a specific hexagon
    dynamic_data: dict = await fox.get_dynamic(hexagon)
    static_data: dict = await fox.get_static(hexagon)
    war_report: dict = await fox.get_war_report(hexagon)

    # Create a map PNG for a hexagon with building informations on it
    map_image = await fox.make_map_png(hexagon)
    map_image.show()

    # to get all the data at once

    data: HexagonObject = await fox.get_hexagon_data(hexagon=hexagon, use_cache=True)


# Register a callback to listen for updates on all the hexagons
# it will run forever don't worry

@fox.on_hexagon_update("all")
def on_update(hexa: HexagonObject):
    print(f"Hexagon {hexa.hexagon} has been updated")


# The following async code works as well

@fox.on_hexagon_update("all")
async def on_update(hexa: HexagonObject):
    print(f"Hexagon {hexa.hexagon} has been updated")

```

### I am not responsible for what you are doing with it