A Python package to query data from NewsAPI in Streamlit apps
Project description
📰 Streamlit-NewsAPI Data Connector
Connect to NewsAPI from your Streamlit app. Powered by st.experimental_connection()
. Works with Streamlit >= 1.22. Read more about Streamlit Connections in the official docs.
Contributions to this repo are welcome. If you are interested in helping to maintain it, reach out to us.
🚀 Quickstart
- Clone the repository:
git clone git@github.com:dcarpintero/st-newsapi-connector.git
- Create and Activate a Virtual Environment:
Windows:
py -m venv .venv
.venv\scripts\activate
macOS/Linux
python3 -m venv .venv
source .venv/bin/activate
- Install dependencies:
pip install -r requirements.txt
- Launch Web Application
streamlit run ./app.py
📄 Minimal Integration
# src/app.py
import streamlit as st
from st_newsapi_connector.connection import NewsAPIConnection
conn_newsapi = st.experimental_connection("NewsAPI", type=NewsAPIConnection)
# Retrieves News Articles on a specific topic from the NewsAPI
df = conn_newsapi.everything(topic="ChatGPT")
st.dataframe(df)
# Retrieves Top-Headlines in a country and category from the NewsAPI
df = conn_newsapi.top_headlines(country='US', category='Science')
st.dataframe(df)
# .streamlit/secrets.toml
NEWSAPI_KEY = 'your-newsapi-key'
NEWSAPI_BASE_URL = 'https://newsapi.org/v2/'
# requirements.txt
pandas==1.5.1
pycountry==22.3.5
requests==2.31.0
streamlit==1.25.0
👩💻 Streamlit Web App
Demo Web App deployed to Streamlit Cloud and available at https://st-newsapi-connector.streamlit.app/
📚 References
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for st-newsapi-connector-0.1.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed1d221d315064fb2623ec2dc716f204bd59544bd64061be39fc21d0e06d6e96 |
|
MD5 | d99761fcfa9b5be9bd45e96a0301593e |
|
BLAKE2b-256 | dcf1cc9ef1cbec71a06b39c855132e87d1151c3e63d61ddce33c94c5dc24109d |
Close
Hashes for st_newsapi_connector-0.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2007af41eed143eacaddaf2155dc6fcec5ebf92dd5aaf3b9097c0da62a8b3519 |
|
MD5 | a6b6282817e80ebf045f9a0886510e4f |
|
BLAKE2b-256 | 215a4133f93b4d6b2c1e57f56a37929b6f7fb6e80fa067a3dc10350932c07f38 |