FIO

FIO class to access game data through FIO REST API endpoints

FIO

FIO(
    version=None,
    application=None,
    api_key=None,
    base_url=None,
    timeout=None,
    ssl_verify=True,
    config=None,
)

FIO API wrapper class

Attributes:

Name	Type	Description
Building	Building	Building information
Exchange	Exchange	Exchange information
Group	Group	Group information
LocalMarket	LocalMarket	LocalMarket information
Material	Material	Material information
Planet	Planet	Planet information
Recipe	Recipe	Recipe information
Sites	Sites	Sites information
Storage	Storage	Storage information
config	Config	FIO Configuration
adapter	FIOAdapter	FIO Adapter
urls	URLs	FIO URLs

Initializes the FIO wrapper

Parameters:

Name	Type	Description	Default
version	str	FIO API version. Defaults to None.	None
application	str	Application name. Defaults to None.	None
api_key	str	FIO API-Key. Defaults to None.	None
base_url	str	FIO base url. Defaults to None.	None
timeout	float	Request timeout. Defaults to None.	None
ssl_verify	bool	Verify https connection. Defaults to True.	True
config	Optional[str]	(str, optional): User specified configuration file. Defaults to None.	None

Raises:

Type	Description
EndpointNotImplemented	description

Source code in fio_wrapper/fio.py

def __init__(
    self,
    version: Optional[str] = None,
    application: Optional[str] = None,
    api_key: Optional[str] = None,
    base_url: Optional[str] = None,
    timeout: Optional[float] = None,
    ssl_verify: Optional[bool] = True,
    config: Optional[str] = None,
) -> None:
    """Initializes the FIO wrapper

    Args:
        version (str, optional): FIO API version. Defaults to None.
        application (str, optional): Application name. Defaults to None.
        api_key (str, optional): FIO API-Key. Defaults to None.
        base_url (str, optional): FIO base url. Defaults to None.
        timeout (float, optional): Request timeout. Defaults to None.
        ssl_verify (bool, optional): Verify https connection. Defaults to True.
        config: (str, optional): User specified configuration file. Defaults to None.

    Raises:
        EndpointNotImplemented: _description_
    """

    # Config needs to already supercede here !!!

    self.config = Config(
        api_key=api_key,
        version=version,
        application=application,
        base_url=base_url,
        timeout=timeout,
        ssl_verify=ssl_verify,
        user_config=config,
    )

    # Check version availability
    if self.config.version not in self.config.versions:
        raise EndpointNotImplemented("FIO version not supported")

    # create adapter
    self.adapter = FIOAdapter(header=self.get_header(), config=self.config)

    # create urls
    self.urls: URLs = URLs(self.config)

    # add version 1.0.0 endpoints
    if self.config.version == "1.0.0":
        self.Building = building_v1.Building(self.adapter, self.urls)
        self.Exchange = exchange_v1.Exchange(self.adapter, self.urls)
        self.Group = group_v1.Group(self.adapter, self.urls)
        self.LocalMarket = localmarket_v1.LocalMarket(self.adapter, self.urls)
        self.Material = material_v1.Material(self.adapter, self.urls)
        self.Planet = planet_v1.Planet(self.adapter, self.urls)
        self.Recipe = recipe_v1.Recipe(self.adapter, self.urls)
        self.Sites = sites_v1.Sites(self.adapter, self.urls)
        self.Storage = storage_v1.Storage(self.adapter, self.urls)

config instance-attribute

config = Config(
    api_key=api_key,
    version=version,
    application=application,
    base_url=base_url,
    timeout=timeout,
    ssl_verify=ssl_verify,
    user_config=config,
)

adapter instance-attribute

adapter = FIOAdapter(
    header=self.get_header(), config=self.config
)

urls instance-attribute

urls = URLs(self.config)

Building instance-attribute

Building = building_v1.Building(self.adapter, self.urls)

Exchange instance-attribute

Exchange = exchange_v1.Exchange(self.adapter, self.urls)

Group instance-attribute

Group = group_v1.Group(self.adapter, self.urls)

LocalMarket instance-attribute

LocalMarket = localmarket_v1.LocalMarket(
    self.adapter, self.urls
)

Material instance-attribute

Material = material_v1.Material(self.adapter, self.urls)

Planet instance-attribute

Planet = planet_v1.Planet(self.adapter, self.urls)

Recipe instance-attribute

Recipe = recipe_v1.Recipe(self.adapter, self.urls)

Sites instance-attribute

Sites = sites_v1.Sites(self.adapter, self.urls)

Storage instance-attribute

Storage = storage_v1.Storage(self.adapter, self.urls)

get_header

get_header()

Creates the header to be included in calls towards FIO

Returns:

Type	Description
Dict[str, str]	Dict[str, str]: Contains "Authorization" and "X-FIO-Application"

Source code in fio_wrapper/fio.py

def get_header(self) -> Dict[str, str]:
    """Creates the header to be included in calls towards FIO

    Returns:
        Dict[str, str]: Contains "Authorization" and "X-FIO-Application"
    """
    return {
        "Authorization": self.config.api_key,
        "X-FIO-Application": self.config.application,
    }