Metadata-Version: 2.1
Name: fds.sdk.FactSetEstimatesReportBuilder
Version: 0.9.1
Summary: FactSet Estimates Report Builder client library for Python
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetEstimatesReportBuilder/v1
Author: FactSet Research Systems
License: Apache-2.0
Keywords: FactSet,API,SDK
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3 (>=1.25.3)
Requires-Dist: python-dateutil
Requires-Dist: fds.sdk.utils (>=0.10.0)

<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">

# FactSet Estimates Report Builder client library for Python

[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetEstimatesReportBuilder)](https://pypi.org/project/fds.sdk.FactSetEstimatesReportBuilder/)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.9.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements

* Python >= 3.6

## Installation

### Poetry

```python
poetry add fds.sdk.utils fds.sdk.FactSetEstimatesReportBuilder
```

### pip

```python
pip install fds.sdk.utils fds.sdk.FactSetEstimatesReportBuilder
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Python environment.
   1. Install and activate python 3.6+. 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.FactSetEstimatesReportBuilder
from fds.sdk.FactSetEstimatesReportBuilder.api import all_estimates_api
from fds.sdk.FactSetEstimatesReportBuilder.model.error_response import ErrorResponse
from fds.sdk.FactSetEstimatesReportBuilder.model.response import Response
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.FactSetEstimatesReportBuilder.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.FactSetEstimatesReportBuilder.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.FactSetEstimatesReportBuilder.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = all_estimates_api.AllEstimatesApi(api_client)
    id = "FDS" # str | Company Ticker
periodicity = "ANN" # str | Periodicity or frequency of the fiscal periods. (optional) (default to "ANN")
schema = "table_parent_child_columns" # str | The schema that the data is returned as. The following are descriptions for the accepted values: - table_group_level - STACH 2.0 row organized package format with parent-child relationships represented using STACH group level cell metadata - table_parent_child_columns - STACH 2.0 row organized package format with parent-child relationships represented using STACH parent-child columns  (optional) (default to "table_parent_child_columns")

    try:
        # Balance Sheet
        api_response = api_instance.get_estimates_balance_sheet(id, periodicity=periodicity, schema=schema)
        pprint(api_response)
    except fds.sdk.FactSetEstimatesReportBuilder.ApiException as e:
        print("Exception when calling AllEstimatesApi->get_estimates_balance_sheet: %s\n" % e)
```

## Documentation for API Endpoints

All URIs are relative to *https://api.factset.com/report/estimates/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AllEstimatesApi* | [**get_estimates_balance_sheet**](docs/AllEstimatesApi.md#get_estimates_balance_sheet) | **GET** /balance-sheet | Balance Sheet
*AllEstimatesApi* | [**get_estimates_cash_flow**](docs/AllEstimatesApi.md#get_estimates_cash_flow) | **GET** /cash-flow | Cash Flow
*AllEstimatesApi* | [**get_estimates_geographic_segments**](docs/AllEstimatesApi.md#get_estimates_geographic_segments) | **GET** /geographic-segments | Geographic Segments
*AllEstimatesApi* | [**get_estimates_income_statement**](docs/AllEstimatesApi.md#get_estimates_income_statement) | **GET** /income-statement | Income Statement
*AllEstimatesApi* | [**get_estimates_industry_metrics**](docs/AllEstimatesApi.md#get_estimates_industry_metrics) | **GET** /industry-metrics | Industry Metrics
*AllEstimatesApi* | [**get_estimates_per_share**](docs/AllEstimatesApi.md#get_estimates_per_share) | **GET** /per-share | Per Share
*AllEstimatesApi* | [**get_estimates_product_segments**](docs/AllEstimatesApi.md#get_estimates_product_segments) | **GET** /product-segments | Product Segments
*AllEstimatesApi* | [**get_estimates_valuation**](docs/AllEstimatesApi.md#get_estimates_valuation) | **GET** /valuation | Valuation
*EstimateTablesApi* | [**get_estimate_tables_table**](docs/EstimateTablesApi.md#get_estimate_tables_table) | **GET** /table | Interim/Annual Estimate Table


## Documentation For Models

 - [Category](docs/Category.md)
 - [CategoryCategory](docs/CategoryCategory.md)
 - [CurrencyCode](docs/CurrencyCode.md)
 - [CurrencyCodeCurrencyCode](docs/CurrencyCodeCurrencyCode.md)
 - [CurrencySymbol](docs/CurrencySymbol.md)
 - [CurrencySymbolCurrencySymbol](docs/CurrencySymbolCurrencySymbol.md)
 - [Description](docs/Description.md)
 - [DescriptionDescription](docs/DescriptionDescription.md)
 - [ErrorObject](docs/ErrorObject.md)
 - [ErrorObjectLinks](docs/ErrorObjectLinks.md)
 - [ErrorObjectSource](docs/ErrorObjectSource.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [Frequency](docs/Frequency.md)
 - [FrequencyFrequency](docs/FrequencyFrequency.md)
 - [Meta](docs/Meta.md)
 - [MetadataEntry](docs/MetadataEntry.md)
 - [MetricEstimates](docs/MetricEstimates.md)
 - [MetricEstimatesMetricEstimates](docs/MetricEstimatesMetricEstimates.md)
 - [Response](docs/Response.md)
 - [Scale](docs/Scale.md)
 - [ScaleScale](docs/ScaleScale.md)
 - [ValueType](docs/ValueType.md)
 - [ValueTypeValueType](docs/ValueTypeValueType.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.FactSetEstimatesReportBuilder.apis and fds.sdk.FactSetEstimatesReportBuilder.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.FactSetEstimatesReportBuilder.api.default_api import DefaultApi`
- `from fds.sdk.FactSetEstimatesReportBuilder.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.FactSetEstimatesReportBuilder
from fds.sdk.FactSetEstimatesReportBuilder.apis import *
from fds.sdk.FactSetEstimatesReportBuilder.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.



