https://github.com/tomfaulkner/brief

Asynchronous data gathering backend for daily briefing displays
https://github.com/tomfaulkner/brief

Last synced: 3 months ago
JSON representation

Asynchronous data gathering backend for daily briefing displays

• Host: GitHub
• URL: https://github.com/tomfaulkner/brief
• Owner: TomFaulkner
• Created: 2020-04-18T22:54:57.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-04-19T01:19:54.000Z (about 5 years ago)
• Last Synced: 2025-01-01T06:27:17.376Z (5 months ago)
• Language: Python
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Brief - REST API Backend to gather data for Daily Briefing displays

** What does that mean?

   The goal of this project is to gather data from various APIs or other sources and return them via REST API. I've been wanting a modern digital picture frame that displays information I choose. This serves the purpose of being the backend of said project. The frontend, probably a React SPA with a mobile UI running on a Pi or a phone with a full-screen browser, doesn't exist yet, but may some day.

** How do I use it?

   - In a terminal run the following:

    : pip install -r requirements.txt

    : BRIEF_OWM_API_KEY=your_api_key_here BRIEF_OWM_CITY_ID=4333669 uvicorn brief.main:app --reload

   - Using your favorite REST API client, or a browser, hit localhost:8000.

   - Parse the json and display it in a pretty manner.