11"""This module contains the basic configuration object that is used to communicate with the MapRoulette API."""
22
3+ from typing import Union
4+
35DEFAULT_HOSTNAME = 'maproulette.org'
46DEFAULT_PROTOCOL = 'https'
57DEFAULT_API_VERSION = '/api/v2'
@@ -11,17 +13,24 @@ def __init__(self, hostname=DEFAULT_HOSTNAME, protocol=DEFAULT_PROTOCOL, api_ver
1113 api_key = None , certs = None , verify = True ):
1214 """Create a new configuration object to connect to the MapRoulette server.
1315
14- :param str hostname: Optional parameter to specify the hostname of the MapRoulette instance being addressed. Do
16+ :param hostname: Optional parameter to specify the hostname of the MapRoulette instance being addressed. Do
1517 not include the protocol (https, http). Default value is 'maproulette.org'.
16- :param str protocol: Optional parameter to specify the protocol to use for the connection to the MapRoulette
18+ :type hostname: str, optional
19+ :param protocol: Optional parameter to specify the protocol to use for the connection to the MapRoulette
1720 instance being addressed such as https or http. Default value is 'https'.
18- :param str api_version: Optional parameter to specify the API version to use. The default is '/api/v2'.
19- :param str api_key: Optional parameter to pass the user-specific API key. This key is necessary for some
20- actions.
21- :param tuple certs: Optional parameter to pass the client-side certificate and key if necessary to make
22- connection with the MapRoulette instance being addressed.
23- :param bool verify: Optional parameter to specify whether to verify SSL certificates for HTTPS requests. Default
21+ :type protocol: str, optional
22+ :param api_version: Optional parameter to specify the API version to use. The default is '/api/v2'.
23+ :type api_version: str, optional
24+ :param api_key: Optional parameter to pass the user-specific API key. This key is necessary for some actions.
25+ :type api_key: str, optional
26+ :param certs: Optional parameter to pass the client-side certificate and key if necessary to make
27+ connection with the MapRoulette instance being addressed. Can be either a tuple containing the cert and key
28+ file paths (in that order) or a string representing the filepath to both the cert and key stored in a single
29+ file.
30+ :type certs: str or tuple, optional
31+ :param verify: Optional parameter to specify whether to verify SSL certificates for HTTPS requests. Default
2432 is True.
33+ :type verify: bool, optional
2534 """
2635 self .api_url = f"{ protocol } ://{ hostname } { api_version } "
2736 self .base_url = f"{ protocol } ://{ hostname } "
0 commit comments