fds.sdk.FactSetProgrammaticEnvironment 0.21.6__py3-none-any.whl

fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/METADATA

@@ -0,0 +1,296 @@
+Metadata-Version: 2.1
+Name: fds.sdk.FactSetProgrammaticEnvironment
+Version: 0.21.6
+Summary: FactSet Programmatic Environment client library for Python
+Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1
+Author: FactSet Research Systems
+License: Apache License, Version 2.0
+Keywords: FactSet,API,SDK
+Platform: UNKNOWN
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3 (>=1.25.3)
+Requires-Dist: python-dateutil
+Requires-Dist: fds.sdk.utils (>=1.0.0)
+
+[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)
+
+# FactSet Programmatic Environment client library for Python
+
+[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetProgrammaticEnvironment)](https://pypi.org/project/fds.sdk.FactSetProgrammaticEnvironment/)
+[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+FactSet Programmatic Environment (FPE) API is an API for users to interact with FPE programmatically, streamlining path from research to production.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 0.21.6
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements
+
+* Python >= 3.7
+
+## Installation
+
+### Poetry
+
+```shell
+poetry add fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment
+```
+
+### pip
+
+```shell
+pip install fds.sdk.utils fds.sdk.FactSetProgrammaticEnvironment
+```
+
+## Usage
+
+1. [Generate authentication credentials](../../../../README.md#authentication).
+2. Setup Python environment.
+   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):
+
+      ```sh
+      pyenv install 3.9.7
+      pyenv shell 3.9.7
+      ```
+
+   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
+3. [Install dependencies](#installation).
+4. Run the following:
+
+```python
+from fds.sdk.utils.authentication import ConfidentialClient
+
+import fds.sdk.FactSetProgrammaticEnvironment
+from fds.sdk.FactSetProgrammaticEnvironment.api import calculations_api
+from fds.sdk.FactSetProgrammaticEnvironment.models import *
+from dateutil.parser import parse as dateutil_parser
+from pprint import pprint
+
+# See configuration.py for a list of all supported configuration parameters.
+
+# Examples for each supported authentication method are below,
+# choose one that satisfies your use case.
+
+# (Preferred) OAuth 2.0: FactSetOAuth2
+# See https://github.com/FactSet/enterprise-sdk#oauth-20
+# for information on how to create the app-config.json file
+# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
+# for more information on using the ConfidentialClient class
+configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
+    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
+)
+
+# Basic authentication: FactSetApiKey
+# See https://github.com/FactSet/enterprise-sdk#api-key
+# for information how to create an API key
+# configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
+#     username='USERNAME-SERIAL',
+#     password='API-KEY'
+# )
+
+# Enter a context with an instance of the API client
+with fds.sdk.FactSetProgrammaticEnvironment.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = calculations_api.CalculationsApi(api_client)
+    # NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.
+    id = "id_example" # str | From url, provided by location header or response body in the calculation start endpoint
+
+    try:
+        # Get calculation status by id
+        # example passing only required values which don't have defaults set
+        api_response = api_instance.analytics_quant_fpe_v1_calculations_id_get(id)
+
+        pprint(api_response)
+    except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
+        print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+
+    # # Get response, http status code and response headers
+    # try:
+    #     # Get calculation status by id
+    #     api_response, http_status_code, response_headers = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info(id)
+
+
+    #     pprint(api_response)
+    #     pprint(http_status_code)
+    #     pprint(response_headers)
+    # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
+    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+
+    # # Get response asynchronous
+    # try:
+    #     # Get calculation status by id
+    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_async(id)
+    #     api_response = async_result.get()
+
+
+    #     pprint(api_response)
+    # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
+    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+
+    # # Get response, http status code and response headers asynchronous
+    # try:
+    #     # Get calculation status by id
+    #     async_result = api_instance.analytics_quant_fpe_v1_calculations_id_get_with_http_info_async(id)
+    #     api_response, http_status_code, response_headers = async_result.get()
+
+
+    #     pprint(api_response)
+    #     pprint(http_status_code)
+    #     pprint(response_headers)
+    # except fds.sdk.FactSetProgrammaticEnvironment.ApiException as e:
+    #     print("Exception when calling CalculationsApi->analytics_quant_fpe_v1_calculations_id_get: %s\n" % e)
+
+```
+
+### Using Pandas
+
+To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
+```python
+import pandas as pd
+
+response_dict = api_response.to_dict()['data']
+
+simple_json_response = pd.DataFrame(response_dict)
+nested_json_response = pd.json_normalize(response_dict)
+```
+
+### Debugging
+
+The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.
+
+Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
+and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).
+
+**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.
+
+```python
+import logging
+import fds.sdk.FactSetProgrammaticEnvironment
+
+logging.basicConfig(level=logging.DEBUG)
+
+configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(...)
+configuration.debug = True
+```
+
+### Configure a Proxy
+
+You can pass proxy settings to the Configuration class:
+
+* `proxy`: The URL of the proxy to use.
+* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).
+
+```python
+import fds.sdk.FactSetProgrammaticEnvironment
+
+configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
+    # ...
+    proxy="http://secret:password@localhost:5050",
+    proxy_headers={
+        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
+    }
+)
+```
+
+### Custom SSL Certificate
+
+TLS/SSL certificate verification can be configured with the following Configuration parameters:
+
+* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
+* `verify_ssl`: setting this to `False` disables the verification of certificates.
+  Disabling the verification is not recommended, but it might be useful during
+  local development or testing.
+
+```python
+import fds.sdk.FactSetProgrammaticEnvironment
+
+configuration = fds.sdk.FactSetProgrammaticEnvironment.Configuration(
+    # ...
+    ssl_ca_cert='/path/to/ca.pem'
+)
+```
+
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.factset.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_get) | **GET** /analytics/quant/fpe/v1/calculations/{id} | Get calculation status by id
+*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_log_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_log_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/log | Get calculation log for a specific calculation
+*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_id_output_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_id_output_get) | **GET** /analytics/quant/fpe/v1/calculations/{id}/output | Get calculation output for a specific calculation
+*CalculationsApi* | [**analytics_quant_fpe_v1_calculations_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationsApi.md#analytics_quant_fpe_v1_calculations_post) | **POST** /analytics/quant/fpe/v1/calculations | Starts a new script calculation
+*FilesApi* | [**analytics_quant_fpe_v1_files_server_file_post**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_server_file_post) | **POST** /analytics/quant/fpe/v1/files/{server}/{file} | Starts a file upload
+*FilesApi* | [**analytics_quant_fpe_v1_files_uploads_id_get**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FilesApi.md#analytics_quant_fpe_v1_files_uploads_id_get) | **GET** /analytics/quant/fpe/v1/files/uploads/{id} | Get upload status by id
+
+
+## Documentation For Models
+
+ - [Calculation](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/Calculation.md)
+ - [CalculationStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/CalculationStatus.md)
+ - [FileUploadStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetProgrammaticEnvironment/v1/docs/FileUploadStatus.md)
+
+
+## Documentation For Authorization
+
+
+## FactSetApiKey
+
+- **Type**: HTTP basic authentication
+
+
+## FactSetOAuth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: N/A
+
+
+## Notes for Large OpenAPI documents
+If the OpenAPI document is large, imports in fds.sdk.FactSetProgrammaticEnvironment.apis and fds.sdk.FactSetProgrammaticEnvironment.models may fail with a
+RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
+
+Solution 1:
+Use specific imports for apis and models like:
+- `from fds.sdk.FactSetProgrammaticEnvironment.api.default_api import DefaultApi`
+- `from fds.sdk.FactSetProgrammaticEnvironment.model.pet import Pet`
+
+Solution 2:
+Before importing the package, adjust the maximum recursion limit as shown below:
+```
+import sys
+sys.setrecursionlimit(1500)
+import fds.sdk.FactSetProgrammaticEnvironment
+from fds.sdk.FactSetProgrammaticEnvironment.apis import *
+from fds.sdk.FactSetProgrammaticEnvironment.models import *
+```
+
+## Contributing
+
+Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
+
+## Copyright
+
+Copyright 2022 FactSet Research Systems Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+

fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/RECORD

@@ -0,0 +1,22 @@
+fds/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fds/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fds/sdk/FactSetProgrammaticEnvironment/__init__.py,sha256=SHrQtvBT_9K6PPnqlOVOEukslgckb9aAHMpcIPI8AKc,1001
+fds/sdk/FactSetProgrammaticEnvironment/api_client.py,sha256=-r8KnZWU6gpqCgFz5TmeiAIoVhDgH6JoaSj0FT1kbMQ,40040
+fds/sdk/FactSetProgrammaticEnvironment/configuration.py,sha256=fG9RumIArOa9Q-wfpF1LCdwqIexwvqv3VXTklcXElhk,18469
+fds/sdk/FactSetProgrammaticEnvironment/exceptions.py,sha256=SPfSowMW0J4XfVzRY-YchUZF0JGv-80dM43134wHHMM,5130
+fds/sdk/FactSetProgrammaticEnvironment/model_utils.py,sha256=MsWqMKyYgcJJKGJEOLPiWfLP6I5ylD2hUaqSa_Aj2C4,82222
+fds/sdk/FactSetProgrammaticEnvironment/rest.py,sha256=8gM_iC_giwTcX-ZuodEzlPxdDICCHmgDysxf2Hh2Qf8,14278
+fds/sdk/FactSetProgrammaticEnvironment/api/__init__.py,sha256=nY_RPsk_ZTxJwDv62FvOOnTqlzafOAbuKz4I1lswTQc,247
+fds/sdk/FactSetProgrammaticEnvironment/api/calculations_api.py,sha256=zx42_rjV6Qxe1cXEDZAwR_A9tf3P792VDmpHC7ZFvmU,45272
+fds/sdk/FactSetProgrammaticEnvironment/api/files_api.py,sha256=R8A31cpPjZ2W0teltJO2J71My3TRlpizePrqXoUlNLc,24789
+fds/sdk/FactSetProgrammaticEnvironment/apis/__init__.py,sha256=WvR3Z-vML3VLiNzabkNkC-0hVqxr7wE_F6fLMFRZqbo,585
+fds/sdk/FactSetProgrammaticEnvironment/model/__init__.py,sha256=N49d9K35V_Hd5lOHWcMeVRl0Iy_-L-03rZgfKXwlESM,348
+fds/sdk/FactSetProgrammaticEnvironment/model/calculation.py,sha256=ILL7WKi0qSyj6Scx0TjaAlYAxItaB_rGmGgPqDetrkw,11600
+fds/sdk/FactSetProgrammaticEnvironment/model/calculation_status.py,sha256=vuvLHr1U3WsAHH0k73glY0lYj2nML-KStfqNI2Ct4Mk,11526
+fds/sdk/FactSetProgrammaticEnvironment/model/file_upload_status.py,sha256=_ugh0jFSXDm8pOlDTc-DYveWWowtmoEsvNNZuQt1DmA,11547
+fds/sdk/FactSetProgrammaticEnvironment/models/__init__.py,sha256=hhGG-bOrBTbOBnWJCd9NjuT3VENw1mALPGzqqSpiDwY,668
+fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/LICENSE,sha256=o360nv5Th1nES3Sbtp01thapHTMCT0CzuS7uq_ro8fw,11358
+fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/METADATA,sha256=yyBfYrcDo5PTKA-pf7pkLfU-z3a6TzII8eIIjJJLbLk,12212
+fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/top_level.txt,sha256=52v1bB-782Xh07STWqzml3q9GVhwaqsY3NCEMiH3Hnc,4
+fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/RECORD,,

fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.37.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fds.sdk.FactSetProgrammaticEnvironment-0.21.6.dist-info/top_level.txt

@@ -0,0 +1 @@
+fds