fds.sdk.StandardDatafeed 0.21.15__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. fds.sdk.StandardDatafeed-0.21.15/LICENSE +202 -0
  2. fds.sdk.StandardDatafeed-0.21.15/PKG-INFO +336 -0
  3. fds.sdk.StandardDatafeed-0.21.15/README.md +321 -0
  4. fds.sdk.StandardDatafeed-0.21.15/fds/__init__.py +0 -0
  5. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/__init__.py +28 -0
  6. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/api/__init__.py +3 -0
  7. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/api/schema_api.py +298 -0
  8. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/api/sdf_and_qfl_content_library_api.py +368 -0
  9. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/api_client.py +939 -0
  10. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/apis/__init__.py +18 -0
  11. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/configuration.py +496 -0
  12. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/exceptions.py +160 -0
  13. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/__init__.py +5 -0
  14. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/dataresponseitems.py +290 -0
  15. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/dataresponseitems_related_bundles.py +260 -0
  16. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/list_files200_response.py +268 -0
  17. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/list_files200_response_meta.py +268 -0
  18. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/list_files400_response.py +260 -0
  19. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/list_schema400_response.py +260 -0
  20. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/list_schemas.py +327 -0
  21. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/meta.py +268 -0
  22. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/pagination.py +268 -0
  23. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/partial.py +256 -0
  24. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/schema_details.py +268 -0
  25. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model/schema_list.py +252 -0
  26. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/model_utils.py +2062 -0
  27. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/models/__init__.py +23 -0
  28. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/StandardDatafeed/rest.py +347 -0
  29. fds.sdk.StandardDatafeed-0.21.15/fds/sdk/__init__.py +0 -0
  30. fds.sdk.StandardDatafeed-0.21.15/fds.sdk.StandardDatafeed.egg-info/PKG-INFO +336 -0
  31. fds.sdk.StandardDatafeed-0.21.15/fds.sdk.StandardDatafeed.egg-info/SOURCES.txt +35 -0
  32. fds.sdk.StandardDatafeed-0.21.15/fds.sdk.StandardDatafeed.egg-info/dependency_links.txt +1 -0
  33. fds.sdk.StandardDatafeed-0.21.15/fds.sdk.StandardDatafeed.egg-info/requires.txt +3 -0
  34. fds.sdk.StandardDatafeed-0.21.15/fds.sdk.StandardDatafeed.egg-info/top_level.txt +1 -0
  35. fds.sdk.StandardDatafeed-0.21.15/setup.cfg +7 -0
  36. fds.sdk.StandardDatafeed-0.21.15/setup.py +47 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2019 FactSet Research Systems Inc
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,336 @@
1
+ Metadata-Version: 2.1
2
+ Name: fds.sdk.StandardDatafeed
3
+ Version: 0.21.15
4
+ Summary: Standard Datafeed client library for Python
5
+ Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1
6
+ Author: FactSet Research Systems
7
+ License: Apache License, Version 2.0
8
+ Keywords: FactSet,API,SDK
9
+ Platform: UNKNOWN
10
+ Requires-Python: >=3.7
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+
14
+ [![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)
15
+
16
+ # Standard Datafeed client library for Python
17
+
18
+ [![API Version](https://img.shields.io/badge/api-v1.2.0-blue)]()
19
+ [![PyPi](https://img.shields.io/pypi/v/fds.sdk.StandardDatafeed)](https://pypi.org/project/fds.sdk.StandardDatafeed/)
20
+ [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
21
+
22
+ The Standard DataFeed (SDF) Download API provides an alternative method for users to request and retrieve SDF packages (schemas & bundles). This service is not a direct replacement and does not have 100% feature parity with the Loader Application. This API provides an alternative for users who are unable to utilize the Loader application due to following reasons:
23
+ - Inability to install 3rd party executables due to Corporate Security policies
24
+ - Inability to utilize the Loader application due to limitations or restrictions with the environment used to consume Standard Datafeed
25
+ - Clients who are utilizing existing delivery method like FTP, who may want to use a more secured & modern solution
26
+
27
+ This API allows users to retrieve maximum of latest 30 days of data
28
+
29
+
30
+ Additional parameters are available to filter requests to get the exact files users are looking for.
31
+
32
+ QFL data is delivered through Content API & Bulk Data API (SDF API)
33
+ - Content API : Provides direct access to FactSet-hosted QFL data. Suitable for interactive, ad hoc QFL requests. Constraints on large extracts. Costs are based on consumption, i.e. more calls can result in more costs.
34
+ - Bulk Data API : Provides access to download locations of zip files for client download. Suitable for production processes within a client environment. Cost is based on the use case and fixed unless scope changes (same as other SDFs).
35
+
36
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
37
+
38
+ - API version: 1.2.0
39
+ - SDK version: 0.21.15
40
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
41
+
42
+ ## Requirements
43
+
44
+ * Python >= 3.7
45
+
46
+ ## Installation
47
+
48
+ ### Poetry
49
+
50
+ ```shell
51
+ poetry add fds.sdk.utils fds.sdk.StandardDatafeed==0.21.15
52
+ ```
53
+
54
+ ### pip
55
+
56
+ ```shell
57
+ pip install fds.sdk.utils fds.sdk.StandardDatafeed==0.21.15
58
+ ```
59
+
60
+ ## Usage
61
+
62
+ 1. [Generate authentication credentials](../../../../README.md#authentication).
63
+ 2. Setup Python environment.
64
+ 1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):
65
+
66
+ ```sh
67
+ pyenv install 3.9.7
68
+ pyenv shell 3.9.7
69
+ ```
70
+
71
+ 2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
72
+ 3. [Install dependencies](#installation).
73
+ 4. Run the following:
74
+
75
+ > [!IMPORTANT]
76
+ > The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
77
+
78
+ ### Example Code
79
+
80
+ ```python
81
+ from fds.sdk.utils.authentication import ConfidentialClient
82
+
83
+ import fds.sdk.StandardDatafeed
84
+ from fds.sdk.StandardDatafeed.api import sdf_and_qfl_content_library_api
85
+ from fds.sdk.StandardDatafeed.models import *
86
+ from dateutil.parser import parse as dateutil_parser
87
+ from pprint import pprint
88
+
89
+ # See configuration.py for a list of all supported configuration parameters.
90
+
91
+ # Examples for each supported authentication method are below,
92
+ # choose one that satisfies your use case.
93
+
94
+ # (Preferred) OAuth 2.0: FactSetOAuth2
95
+ # See https://github.com/FactSet/enterprise-sdk#oauth-20
96
+ # for information on how to create the app-config.json file
97
+ #
98
+ # The confidential client instance should be reused in production environments.
99
+ # See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
100
+ # for more information on using the ConfidentialClient class
101
+ configuration = fds.sdk.StandardDatafeed.Configuration(
102
+ fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
103
+ )
104
+
105
+ # Basic authentication: FactSetApiKey
106
+ # See https://github.com/FactSet/enterprise-sdk#api-key
107
+ # for information how to create an API key
108
+ # configuration = fds.sdk.StandardDatafeed.Configuration(
109
+ # username='USERNAME-SERIAL',
110
+ # password='API-KEY'
111
+ # )
112
+
113
+ # Enter a context with an instance of the API client
114
+ with fds.sdk.StandardDatafeed.ApiClient(configuration) as api_client:
115
+ # Create an instance of the API class
116
+ api_instance = sdf_and_qfl_content_library_api.SDFAndQFLContentLibraryApi(api_client)
117
+ schema = "schema_example" # str | schema name</p> </p> **Example: acta_v1, fgp_v1, yn_v1** QFL:- To query QFL data, please use value: **qfl_v1** (optional)
118
+ bundle = "bundle_example" # str | bundle name</p> If this parameter is not passed in the request, all the bundles a client is subscribed to are returned. QFL:- - For QFL its the factor group name - If this parameter is not passed in the request, all the the factor families & factor groups subscribed to by the user are returned. - Supports comma separated list of multiple factor groups (optional)
119
+ type = "full" # str | file type = Full or Delta</p> Full files are weekly files generated every weekend (Saturday). **The date range should include weekend dates if requesting for \"Full\" files** (optional)
120
+ start_date = "startDate_example" # str | The earliest date of the feed file the API should fetch for based on the fileTimestamp.</p> - If the schema parameter is specified in the request, date range can be greater than 10 days maximum upto latest 30 days. - If startDate and endDate parameters are not specified in the request, this endpoint returns past 10 days data by default. - startDate can be absolute- YYYY-MM-DD or relative:- -1 for yesterday (optional)
121
+ end_date = "endDate_example" # str | The latest date of the feed file the API should fetch for based on the fileTimestamp If startDate and endDate parameters are not specified in the request, this endpoint returns past 10 days data by default. endDate can be in absolute- YYYY-MM-DD or relative date:- 0 for today (optional)
122
+ pagination_limit = 20 # int | Specifies the number of results to return per page. Default is 20 & Maximum is 500 results per page (optional) if omitted the server will use the default value of 20
123
+ pagination_offset = 0 # int | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional) if omitted the server will use the default value of 0
124
+ sort = "startDate" # str | Enables to get the data in ascending or descending order based on startTime. Results are in reverse chronological order if this parameter is not used (optional) if omitted the server will use the default value of "startDate"
125
+
126
+ try:
127
+ # example passing only required values which don't have defaults set
128
+ # and optional values
129
+ api_response = api_instance.get_v1_list_files(schema=schema, bundle=bundle, type=type, start_date=start_date, end_date=end_date, pagination_limit=pagination_limit, pagination_offset=pagination_offset, sort=sort)
130
+
131
+ pprint(api_response)
132
+ except fds.sdk.StandardDatafeed.ApiException as e:
133
+ print("Exception when calling SDFAndQFLContentLibraryApi->get_v1_list_files: %s\n" % e)
134
+
135
+ # # Get response, http status code and response headers
136
+ # try:
137
+ # api_response, http_status_code, response_headers = api_instance.get_v1_list_files_with_http_info(schema=schema, bundle=bundle, type=type, start_date=start_date, end_date=end_date, pagination_limit=pagination_limit, pagination_offset=pagination_offset, sort=sort)
138
+
139
+
140
+ # pprint(api_response)
141
+ # pprint(http_status_code)
142
+ # pprint(response_headers)
143
+ # except fds.sdk.StandardDatafeed.ApiException as e:
144
+ # print("Exception when calling SDFAndQFLContentLibraryApi->get_v1_list_files: %s\n" % e)
145
+
146
+ # # Get response asynchronous
147
+ # try:
148
+ # async_result = api_instance.get_v1_list_files_async(schema=schema, bundle=bundle, type=type, start_date=start_date, end_date=end_date, pagination_limit=pagination_limit, pagination_offset=pagination_offset, sort=sort)
149
+ # api_response = async_result.get()
150
+
151
+
152
+ # pprint(api_response)
153
+ # except fds.sdk.StandardDatafeed.ApiException as e:
154
+ # print("Exception when calling SDFAndQFLContentLibraryApi->get_v1_list_files: %s\n" % e)
155
+
156
+ # # Get response, http status code and response headers asynchronous
157
+ # try:
158
+ # async_result = api_instance.get_v1_list_files_with_http_info_async(schema=schema, bundle=bundle, type=type, start_date=start_date, end_date=end_date, pagination_limit=pagination_limit, pagination_offset=pagination_offset, sort=sort)
159
+ # api_response, http_status_code, response_headers = async_result.get()
160
+
161
+
162
+ # pprint(api_response)
163
+ # pprint(http_status_code)
164
+ # pprint(response_headers)
165
+ # except fds.sdk.StandardDatafeed.ApiException as e:
166
+ # print("Exception when calling SDFAndQFLContentLibraryApi->get_v1_list_files: %s\n" % e)
167
+
168
+ ```
169
+
170
+ ### Using Pandas
171
+
172
+ To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
173
+ ```python
174
+ import pandas as pd
175
+
176
+ response_dict = api_response.to_dict()['data']
177
+
178
+ simple_json_response = pd.DataFrame(response_dict)
179
+ nested_json_response = pd.json_normalize(response_dict)
180
+ ```
181
+
182
+ ### Debugging
183
+
184
+ The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.
185
+
186
+ Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
187
+ and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).
188
+
189
+ **Note**: This prints out sensitive information (e.g. the full request and response). Use with care.
190
+
191
+ ```python
192
+ import logging
193
+ import fds.sdk.StandardDatafeed
194
+
195
+ logging.basicConfig(level=logging.DEBUG)
196
+
197
+ configuration = fds.sdk.StandardDatafeed.Configuration(...)
198
+ configuration.debug = True
199
+ ```
200
+
201
+ ### Configure a Proxy
202
+
203
+ You can pass proxy settings to the Configuration class:
204
+
205
+ * `proxy`: The URL of the proxy to use.
206
+ * `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).
207
+
208
+ ```python
209
+ import fds.sdk.StandardDatafeed
210
+
211
+ configuration = fds.sdk.StandardDatafeed.Configuration(
212
+ # ...
213
+ proxy="http://secret:password@localhost:5050",
214
+ proxy_headers={
215
+ "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
216
+ }
217
+ )
218
+ ```
219
+
220
+ ### Custom SSL Certificate
221
+
222
+ TLS/SSL certificate verification can be configured with the following Configuration parameters:
223
+
224
+ * `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
225
+ * `verify_ssl`: setting this to `False` disables the verification of certificates.
226
+ Disabling the verification is not recommended, but it might be useful during
227
+ local development or testing.
228
+
229
+ ```python
230
+ import fds.sdk.StandardDatafeed
231
+
232
+ configuration = fds.sdk.StandardDatafeed.Configuration(
233
+ # ...
234
+ ssl_ca_cert='/path/to/ca.pem'
235
+ )
236
+ ```
237
+
238
+ ### Request Retries
239
+
240
+ In case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.
241
+
242
+ ```python
243
+ from urllib3 import Retry
244
+ import fds.sdk.StandardDatafeed
245
+
246
+ configuration = fds.sdk.StandardDatafeed.Configuration(
247
+ # ...
248
+ )
249
+
250
+ configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
251
+ ```
252
+
253
+
254
+ ## Documentation for API Endpoints
255
+
256
+ All URIs are relative to *https://api.factset.com/bulk-documents/sdf/v1*
257
+
258
+ Class | Method | HTTP request | Description
259
+ ------------ | ------------- | ------------- | -------------
260
+ *SDFAndQFLContentLibraryApi* | [**get_v1_list_files**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/SDFAndQFLContentLibraryApi.md#get_v1_list_files) | **GET** /list-files |
261
+ *SchemaApi* | [**get_v1_list_schemas**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/SchemaApi.md#get_v1_list_schemas) | **GET** /list-schemas | schemas
262
+
263
+
264
+ ## Documentation For Models
265
+
266
+ - [Dataresponseitems](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/Dataresponseitems.md)
267
+ - [DataresponseitemsRelatedBundles](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/DataresponseitemsRelatedBundles.md)
268
+ - [ListFiles200Response](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/ListFiles200Response.md)
269
+ - [ListFiles200ResponseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/ListFiles200ResponseMeta.md)
270
+ - [ListFiles400Response](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/ListFiles400Response.md)
271
+ - [ListSchema400Response](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/ListSchema400Response.md)
272
+ - [ListSchemas](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/ListSchemas.md)
273
+ - [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/Meta.md)
274
+ - [Pagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/Pagination.md)
275
+ - [Partial](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/Partial.md)
276
+ - [SchemaDetails](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/SchemaDetails.md)
277
+ - [SchemaList](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/StandardDatafeed/v1/docs/SchemaList.md)
278
+
279
+
280
+ ## Documentation For Authorization
281
+
282
+
283
+ ## FactSetApiKey
284
+
285
+ - **Type**: HTTP basic authentication
286
+
287
+
288
+ ## FactSetOAuth2
289
+
290
+ - **Type**: OAuth
291
+ - **Flow**: application
292
+ - **Authorization URL**:
293
+ - **Scopes**: N/A
294
+
295
+
296
+ ## Notes for Large OpenAPI documents
297
+ If the OpenAPI document is large, imports in fds.sdk.StandardDatafeed.apis and fds.sdk.StandardDatafeed.models may fail with a
298
+ RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
299
+
300
+ Solution 1:
301
+ Use specific imports for apis and models like:
302
+ - `from fds.sdk.StandardDatafeed.api.default_api import DefaultApi`
303
+ - `from fds.sdk.StandardDatafeed.model.pet import Pet`
304
+
305
+ Solution 2:
306
+ Before importing the package, adjust the maximum recursion limit as shown below:
307
+ ```
308
+ import sys
309
+ sys.setrecursionlimit(1500)
310
+ import fds.sdk.StandardDatafeed
311
+ from fds.sdk.StandardDatafeed.apis import *
312
+ from fds.sdk.StandardDatafeed.models import *
313
+ ```
314
+
315
+ ## Contributing
316
+
317
+ Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
318
+
319
+ ## Copyright
320
+
321
+ Copyright 2022 FactSet Research Systems Inc
322
+
323
+ Licensed under the Apache License, Version 2.0 (the "License");
324
+ you may not use this file except in compliance with the License.
325
+ You may obtain a copy of the License at
326
+
327
+ http://www.apache.org/licenses/LICENSE-2.0
328
+
329
+ Unless required by applicable law or agreed to in writing, software
330
+ distributed under the License is distributed on an "AS IS" BASIS,
331
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
332
+ See the License for the specific language governing permissions and
333
+ limitations under the License.
334
+
335
+
336
+