News API for Digital Portals client library for Python

Project description

News API for Digital Portals client library for Python

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

This Python package is automatically generated by the OpenAPI Generator project:

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

Requirements

Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.NewsAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.NewsAPIforDigitalPortals

Usage

Generate authentication credentials.
Setup Python environment.
1. Install and activate python 3.6+. If you're using pyenv:
```
pyenv install 3.9.7
pyenv shell 3.9.7
```
2. (optional) Install poetry.
Install dependencies.
Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.NewsAPIforDigitalPortals
from fds.sdk.NewsAPIforDigitalPortals.api import news_api
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object1 import InlineObject1
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object2 import InlineObject2
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object3 import InlineObject3
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object4 import InlineObject4
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object5 import InlineObject5
from fds.sdk.NewsAPIforDigitalPortals.model.inline_object6 import InlineObject6
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2004 import InlineResponse2004
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2005 import InlineResponse2005
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2006 import InlineResponse2006
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2007 import InlineResponse2007
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2008 import InlineResponse2008
from fds.sdk.NewsAPIforDigitalPortals.model.inline_response2009 import InlineResponse2009
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.NewsAPIforDigitalPortals.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.NewsAPIforDigitalPortals.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.NewsAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = news_api.NewsApi(api_client)
    code = "0" # str | Identifier of a news article.
include_media = False # bool | If true, media references are included if available. (optional) (default to False)
attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
language = "_language_example" # str | ISO 639-1 code of the language. (optional)

    try:
        # Details for a news article.
        api_response = api_instance.get_news_article_get(code, include_media=include_media, attributes=attributes, language=language)
        pprint(api_response)
    except fds.sdk.NewsAPIforDigitalPortals.ApiException as e:
        print("Exception when calling NewsApi->get_news_article_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://api.factset.com/wealth/v1

Class	Method	HTTP request	Description
NewsApi	get_news_article_get	GET /news/article/get	Details for a news article.
NewsApi	get_news_article_type_get	GET /news/article/type/get	Details for a news article type.
NewsApi	get_news_article_type_list	GET /news/article/type/list	List of news article types.
NewsApi	get_news_distributor_get	GET /news/distributor/get	Details of a distributor.
NewsApi	get_news_distributor_list	GET /news/distributor/list	List of distributors.
NewsApi	get_news_publisher_get	GET /news/publisher/get	Details of a publisher.
NewsApi	get_news_publisher_list	GET /news/publisher/list	List of publishers.
NewsApi	get_news_publisher_list_by_distributor	GET /news/publisher/listByDistributor	List of publishers provided by the given distributor.
NewsApi	post_news_article_list	POST /news/article/list	List of news articles.
NewsApi	post_news_article_list_by_chain	POST /news/article/listByChain	List news articles of an article chain.
NewsApi	post_news_article_list_by_index	POST /news/article/listByIndex	News articles for instruments that are constituents of the given indices.
NewsApi	post_news_article_list_by_instrument	POST /news/article/listByInstrument	News articles for instruments.
NewsApi	post_news_article_list_by_media_kind	POST /news/article/listByMediaKind	List news articles which contain media of specific media kinds.
NewsApi	post_news_article_search_by_text	POST /news/article/searchByText	Search for news articles using a fulltext search.
NewsApi	post_news_publisher_search_by_name	POST /news/publisher/searchByName	Search for publishers.

Documentation For Models

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.NewsAPIforDigitalPortals.apis and fds.sdk.NewsAPIforDigitalPortals.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.NewsAPIforDigitalPortals.api.default_api import DefaultApi
from fds.sdk.NewsAPIforDigitalPortals.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.NewsAPIforDigitalPortals
from fds.sdk.NewsAPIforDigitalPortals.apis import *
from fds.sdk.NewsAPIforDigitalPortals.models import *

Contributing

Please refer to the contributing guide.

Copyright

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.

Project details

Release history Release notifications | RSS feed

0.10.10

Oct 25, 2023

0.10.9

Aug 30, 2023

0.10.8

Jun 6, 2023

0.10.7

May 17, 2023

0.10.6

May 12, 2023

0.10.5

May 11, 2023

0.10.4

Feb 24, 2023

0.10.3

Dec 15, 2022

0.10.2

Aug 31, 2022

0.10.1

Jul 21, 2022

0.10.0

May 24, 2022

This version

0.9.1

Feb 14, 2022

0.9.0

Feb 2, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.NewsAPIforDigitalPortals-0.9.1-py3-none-any.whl (290.7 kB view details)

Uploaded Feb 14, 2022 Python 3

File details

Details for the file fds.sdk.NewsAPIforDigitalPortals-0.9.1-py3-none-any.whl.

File metadata

Download URL: fds.sdk.NewsAPIforDigitalPortals-0.9.1-py3-none-any.whl
Upload date: Feb 14, 2022
Size: 290.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for fds.sdk.NewsAPIforDigitalPortals-0.9.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`10ebfad3d7cfedf3b0a2905da5ca3351d3725f5604a095c57b13689cdacdf9e6`
MD5	`a5beb0d2a578bfc8490a61e776a0802e`
BLAKE2b-256	`273de217c4d2f9f14157cc89892cb9fae4f19dfda498d1ffb42fcc994746f920`