Skip to main content

A Python client to interact with News API from NewApi.org

Project description

Based on the updated structure of your library, here's a revised README:

NewsAPI Python Client

Description

This project provides a Python client for accessing the NewsAPI. It simplifies the process of integrating news search capabilities into your applications. Whether you're building a news aggregation service, a stock trading platform that needs financial news, or a social media app that wants to display relevant news to users, this library is here to assist.

Features

  • Intuitive Python interface for NewsAPI.
  • Leverages the requests library for HTTP requests.
  • Employs an object-oriented model for both requests and responses.
  • Supports all parameters of the NewsAPI, including advanced search queries and filtering.
  • Designed for flexibility and extensibility, allowing for customization as needed.

Installation

pip install newsapi-python-client

Usage

First, you need to initialize the NewsAPIService with your NewsAPI key.

import os
from newsApi.service import NewsAPIService  

news_api_service = NewsAPIService(os.environ.get('NEWS_API_KEY'))

Then you can use the service to make requests. Here is an example for retrieving news about finance:

from newsApi.models.request import EverythingRequestModel

request_model = EverythingRequestModel(
    q='finance',
)

response = news_api_service.everything(request_model)

for article in response.articles:
    print(f"Title: {article.title}")
    print(f"URL: {article.url}")
    print("---")

Note: Remember to replace placeholder values in the EverythingRequestModel with actual values.

Requirements

  • Python 3.6 or later
  • requests package

Future Plans

  • Enhance error handling and validation.
  • Include more examples and use cases.
  • Develop comprehensive documentation.

Contributing

Contributions from the community are welcome. Please refer to the CONTRIBUTING.md file for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Project details


Download files

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

Source Distribution

newsapi-python-client-0.2.4.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

newsapi_python_client-0.2.4-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file newsapi-python-client-0.2.4.tar.gz.

File metadata

  • Download URL: newsapi-python-client-0.2.4.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for newsapi-python-client-0.2.4.tar.gz
Algorithm Hash digest
SHA256 1055f0d31ebacf99bcc56936996b4b0bd01cfe8dc9cd6b2013cfc8a71ccff215
MD5 bbdd37a6c7d9e49e07f7bc785d1de2e1
BLAKE2b-256 3dcd3a9a79a8c20a57dd5f3fb392712b22f16bbc0c0c3790dc34f71ea62a08c5

See more details on using hashes here.

File details

Details for the file newsapi_python_client-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for newsapi_python_client-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e1c14dc8c18bb2a7cd7c59884dca9156cd7b62471646951297a25dec8804252a
MD5 7b8f6a85f559232aa29b70d9506488e0
BLAKE2b-256 432ad18af2150aa38d93b85b228d68818735887c9ce6ce967b38f45c7c13da3a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page