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://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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e81fca24fea3d3a89f176f9f4bde4edd78fb24bfc052d94fd20a347cd46b77e |
|
MD5 | 30cc8c65a056d3a3e49436e6b9b16ca0 |
|
BLAKE2b-256 | e345c0718e5e2a43c3d815a664ef162baeb3963cabebe2ba43c34f8f9c517200 |
Close
Hashes for st_newsapi_connector-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d28c2e432e8d77ec29dcad699645a8330c548361c3f213f8421b72e7325c4c71 |
|
MD5 | 1600846870da30cf5cc82af7098bb40b |
|
BLAKE2b-256 | 41b6fe60bf6f73cca3c523bc78e91133920281bbc1a8ee876481ebf0b4b274c0 |