@@ -13,6 +13,22 @@ class EnigmaReader(_BaseReader):
13
13
Collects current snapshot of Enigma data located at the specified
14
14
data set ID and returns a pandas DataFrame.
15
15
16
+ Parameters
17
+ ----------
18
+ dataset_id : str
19
+ Enigma dataset UUID.
20
+ api_key : str, optional
21
+ Enigma API key. If not provided, the environmental variable
22
+ ENIGMA_API_KEY is read.
23
+ retry_count : int, (defaults to 5)
24
+ Number of times to retry query request.
25
+ pause : float, (defaults to 0.75)
26
+ Time, in seconds, of the pause between retries.
27
+ session : Session, (defaults to None)
28
+ requests.sessions.Session instance to be used.
29
+ base_url : str, optional (defaults to https://public.enigma.com/api)
30
+ Alternative Enigma endpoint to be used.
31
+
16
32
Examples
17
33
--------
18
34
Download current snapshot for the following Florida Inspections Dataset:
@@ -32,7 +48,8 @@ def __init__(self,
32
48
api_key = None ,
33
49
retry_count = 5 ,
34
50
pause = .75 ,
35
- session = None ):
51
+ session = None ,
52
+ base_url = "https://public.enigma.com/api" ):
36
53
37
54
super (EnigmaReader , self ).__init__ (symbols = [],
38
55
retry_count = retry_count ,
@@ -58,7 +75,7 @@ def __init__(self,
58
75
'User-Agent' : 'pandas-datareader' ,
59
76
}
60
77
self .session .headers .update (headers )
61
- self ._base_url = "https://public.enigma.com/api"
78
+ self ._base_url = base_url
62
79
self ._retry_count = retry_count
63
80
self ._retry_delay = pause
64
81
0 commit comments