Skip to main content

A simple wrapper for the Athena News API to simplify searching for articles.

Project description

Athena News API Wrapper

A simple Python wrapper for the Athena News API that simplifies querying and retrieving news articles.

Features

  • Simplified API Access: Easily send queries to the Athena News API.
  • Automatic Polling: Automatically polls until the query is processed.
  • Pagination Handling: Fetches all available articles across multiple pages.

Installation

Install the package via pip (after publishing to PyPI):

pip install athenanewsapi

Or install directly from source:

git clone https://github.com/athenanewsapi/athenanews.git
cd athenanewsapi
pip install .

Then get your API key by creating an Athena account.

Usage

Import the package and call the news function with the required parameters:

from athenanewsapi import news

articles = news(
    start_date="2025-03-01T15:13:52.466Z",
    end_date="2025-03-20T15:13:52.466Z",
    query="Tesla dealership protests",
    key_phrases="('tesla takedown')",
    toggle_state="All Articles",
    api_key="YOUR_API_KEY"
)

print("Total articles fetched:", len(articles))

API Reference

news(start_date, end_date, query, key_phrases, toggle_state, api_key)

  • start_date (str): ISO formatted start date.
  • end_date (str): ISO formatted end date.
  • query (str): The search query.
  • key_phrases (str): Key phrases to refine the search. (ex: ('elon' or 'musk') and not 'sam altman')
  • toggle_state (str): The toggle state (e.g., "All Articles" or "Encoded Articles").
  • api_key (str): Your Athena API key.

Returns: A list of articles returned by the API.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

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

athenanewsapi-0.1.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

athenanewsapi-0.1.2-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file athenanewsapi-0.1.2.tar.gz.

File metadata

  • Download URL: athenanewsapi-0.1.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for athenanewsapi-0.1.2.tar.gz
Algorithm Hash digest
SHA256 aa000c9fafd8e707b35ef7ee3cd671f5a08e9c895dddb646f104db50aaf62fe3
MD5 acf60916c6669669403f67a0cb675021
BLAKE2b-256 e77cfc2e94d6be6de578c5e6ad7c8f262270d99fc480ad6f0738d6e0746a794c

See more details on using hashes here.

File details

Details for the file athenanewsapi-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: athenanewsapi-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for athenanewsapi-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 51667d81d5e8c0dbe82ae08555119107995e4b28dd17c5322b2cbc0156f3f596
MD5 d982e4e0b4711bf3e7a9096909dd8fe1
BLAKE2b-256 6fc6c958dfd230075e3772472012583ad8f4d928ad4b8fdbb3beae8b7c16e41a

See more details on using hashes here.

Supported by

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