Merge pull request #18 from jplacht/feat-config

Add configuration file solution

Author: jplacht

.coveragerc

@@ -7,3 +7,5 @@ omit =
     tests/*
     # omit abstract endpoints
     */abstracts/*
+    # omit config due to base_config
+    */config.py

docs/config.md

@@ -0,0 +1,69 @@
+# Config
+
+FIO Wrapper internally uses a configuration file to provide its standard capabilities. The configuration can be [overwritten](usage.md) by the user.
+
+
+
+## `base.ini`
+
+```ini
+[FIO]
+application = FIO Wrapper
+version = 1.0.0
+base_url = https://rest.fnar.net
+timeout = 10
+ssl_verify = True
+versions = 1.0.0
+
+[URL]
+# material
+1.0.0_material_base = /material
+1.0.0_material_all = /allmaterials
+
+# exchange
+1.0.0_exchange_base = /exchange
+1.0.0_exchange_orders = /orders
+1.0.0_exchange_all = /all
+1.0.0_exchange_full = /full
+
+# building
+1.0.0_building_base = /building
+1.0.0_building_all = /allbuildings
+
+# recipe
+1.0.0_recipe_base = /recipes
+1.0.0_recipe_all = /allrecipes
+
+# planet
+1.0.0_planet_base = /planet
+1.0.0_planet_all = /allplanets
+1.0.0_planet_full = /allplanets/full
+1.0.0_planet_sites = /sites
+1.0.0_planet_search = /search
+
+# localmarket
+1.0.0_localmarket_base = /localmarket
+1.0.0_localmarket_planet = /planet
+1.0.0_localmarket_shipping_source = /shipping/source
+1.0.0_localmarket_shipping_destination = /shipping/destination
+1.0.0_localmarket_company = /company
+
+# sites
+1.0.0_sites_base = /sites
+1.0.0_sites_planets = /planets
+1.0.0_sites_warehouses = /warehouses
+
+# storage
+1.0.0_storage_base = /storage
+1.0.0_storage_planets = /planets
+
+# groups
+1.0.0_groups = /auth/groups
+1.0.0_groups_group = /auth/group
+1.0.0_groups_groupmemberships = /auth/groupmemberships
+1.0.0_groups_hub = /fioweb/grouphub
+1.0.0_groups_burn = /fioweb/burn/group
+```
+
+## Config() class
+::: config

docs/timeouts.md

@@ -23,6 +23,10 @@ fio = FIO(timeout=5)
 
 FIO Wrapper will now apply the timeout of `5 seconds` to all calls it is making towards FIO.
 
+## Configuration file
+
+A standard timeout can also be defined in a users [configuration file](config.md).
+
 ## Indidivual endpoint calls
 
 All endpoints allow passing the optional `timeout` argument that is of type `Optional[float]` and defaults to `None`.

docs/usage.md

@@ -1,9 +1,10 @@
-# Installation
+# Usage
+## Installation
 ```python
 pip install fio-wrapper
 ```
 
-# Usage
+## Simple Usage
 Creating the FIO adapter and looking for information about the material Drinking Water by its ticker "DW".
 ```python
 from fio_wrapper import FIO
@@ -30,3 +31,36 @@ This will print the material information of Drinking Water as MaterialModel and
     "Timestamp": "2023-10-28T19:26:21.831707"
 }
 ```
+
+## Additional parameters
+
+FIO Wrapper allows you to specify additional attributes when instantiating. The most commonly used is `api_key` that lets you add your FIO API Key (obtained on the [FIO Website](https://fio.fnar.net/settings)) to access protected endpoints like [Site](endpoints/sites.md) or [Storage](endpoints/storage.md).
+
+```python
+from fio_wrapper import FIO
+
+fio = FIO(api_key="YOUR_FIO_API_KEY")
+```
+
+The complete list of parameters can be found on [`FIO()`](fio.md).
+
+## Configuration file
+
+FIO Wrapper can use a configuration file provided upon instantiation to overwrite its [base configuration](config.md).
+
+Example configuration file `config.ini`:
+
+```ini
+[FIO]
+application = My Awesome FIO application
+timeout = 3
+api_key = MY_FIO_API_KEY
+```
+
+Use this configuration file on [`FIO()`](fio.md) by providing the `config` attribute:
+
+```python
+from fio_wrapper import FIO
+
+fio = FIO(config="config.ini")
+```

fio_wrapper/base.ini

@@ -0,0 +1,56 @@
+[FIO]
+application = FIO Wrapper
+version = 1.0.0
+base_url = https://rest.fnar.net
+timeout = 10
+ssl_verify = True
+versions = 1.0.0
+
+[URL]
+# material
+1.0.0_material_base = /material
+1.0.0_material_all = /allmaterials
+
+# exchange
+1.0.0_exchange_base = /exchange
+1.0.0_exchange_orders = /orders
+1.0.0_exchange_all = /all
+1.0.0_exchange_full = /full
+
+# building
+1.0.0_building_base = /building
+1.0.0_building_all = /allbuildings
+
+# recipe
+1.0.0_recipe_base = /recipes
+1.0.0_recipe_all = /allrecipes
+
+# planet
+1.0.0_planet_base = /planet
+1.0.0_planet_all = /allplanets
+1.0.0_planet_full = /allplanets/full
+1.0.0_planet_sites = /sites
+1.0.0_planet_search = /search
+
+# localmarket
+1.0.0_localmarket_base = /localmarket
+1.0.0_localmarket_planet = /planet
+1.0.0_localmarket_shipping_source = /shipping/source
+1.0.0_localmarket_shipping_destination = /shipping/destination
+1.0.0_localmarket_company = /company
+
+# sites
+1.0.0_sites_base = /sites
+1.0.0_sites_planets = /planets
+1.0.0_sites_warehouses = /warehouses
+
+# storage
+1.0.0_storage_base = /storage
+1.0.0_storage_planets = /planets
+
+# groups
+1.0.0_groups = /auth/groups
+1.0.0_groups_group = /auth/group
+1.0.0_groups_groupmemberships = /auth/groupmemberships
+1.0.0_groups_hub = /fioweb/grouphub
+1.0.0_groups_burn = /fioweb/burn/group