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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

Supported by

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