Skip to content

AI-enabled 'Read Mode' that transforms the stylistically disjointed act of reading things on the internet into a clean, less distracting, and queryable experience. Developed as part of Stanford's Tech-16: LLMs for Business with Python

License

Notifications You must be signed in to change notification settings

francisgreenleaf/Reader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📚 Reader App

The Reader App is a web application that allows users to fetch articles from a given URL, view the content, generate a PDF version of the article, and query the article using natural language processing techniques.

Setup

  1. Clone this repository to your local machine.

  2. Navigate to the project directory cd Reader.

  3. Create a .env file in the project directory and set your OpenAI API key as an environment variable: OPENAI_API_KEY=YOUR_REAL_KEY

    If you don't have an OpenAI API Key, sign into platform.openai.com and generate one there.

  4. Install the required dependencies:

     pip install -r requirements.txt
  5. Run the app using the following command:

    python app.py
  6. Open your web browser and go to the URL provided by Streamlit (usually https://localhost:8080).

Usage

  1. Enter the URL of the article you want to fetch in the provided input field.

  2. Click the "Fetch Article" button to retrieve the article content.

  3. The article's title, summary, and content will be displayed on the page.

  4. You can download a PDF version of the article by clicking the "Download as PDF" button.

  5. To query the article, enter your query in the provided input field and click the "Submit Query" button.

  6. The app will process your query using natural language processing techniques and display the relevant information from the article.

Contributing

If you'd like to contribute to the Reader App, feel free to submit a pull request or open an issue on the GitHub repository.

Acknowledgements

This app was developed as part of the Stanford Continuing Studies class TECH-16: LLMs for Business with Python taught by Charlie Flanagan. The app owes its thanks to him, Dima Timofeev, and many others including the teams who built the app's various dependencies.

License

This project is open-source and available under the Apache License 2.0.

About

AI-enabled 'Read Mode' that transforms the stylistically disjointed act of reading things on the internet into a clean, less distracting, and queryable experience. Developed as part of Stanford's Tech-16: LLMs for Business with Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published