reidy-p / resurface Goto Github PK

Get reminders to revisit your favourite content

Python 41.55% HTML 52.65% CSS 5.80%

resurface's Introduction

Resurface

With so much amazing content on the web it can be hard to remember to revisit your favourite articles, videos, or Tweets. Resurface gathers all of your favourite content from the web in one place and sends your regular reminders with samples of your favourites so you can rediscover the best of the web.

Try it at: https://getresurface.net

Features

Import your favourite content from popular sites like Pocket, YouTube, etc. to view them all in one place
Receive periodic e-mails with reminders to rediscover a sample of these favourites
[Planned] Quickly search across all of your favourite content

Technologies

Built using:

Flask Web Framework for Python
SendGrid E-mail API for automating e-mails
SQLite
APScheduler for scheduling reminders
Bootstrap for styling
AWS Route 53 for domain name registration
Zoho for associating an e-mail address with the domain name

Config File

Running the application requires a file called config.py in the root directory with the following values:

class Config:
    SECRET_KEY=''
    # Pocket API key
    POCKET_CONSUMER_KEY=''
    # SendGrid API Key
    MAIL_PASSWORD=""
    MAIL_DEFAULT_SENDER=""

It also requires keys from Google's API with permissions to view your YouTube channel. This file should also be stored in the root directory and named google_api_secrets.json.

resurface's People

Contributors

Watchers

resurface's Issues

Create account settings page

Fix Javascript 404s

Maintain state for job schedule

If the application crashes we should be able to restart with all the job schedules in tact. There is some information on this in the apscheduler docs

Readwise Integration

https://readwise.io/api_deets

Remove items from saved items

Continuous syncing for Pocket

E-mail layout

Improve the layout of the Resurface reminder e-mail to use more styling and HTML

Delete reminder

Add the ability to remove a reminder

Make index.html extend base.html

Add YouTube integration for liked videos

Extend manual import option to allow documents

This might require a dynamic form of some type

Warn or block reminders if no items imported

Convert to permalinks

Add the ability to convert links to permalinks

Add more than one reminder

It should be possible to have more than one reminder for each user and to modify these reminders from the web UI

Setup proper email address using domain name

Add more import options

Verify app on Google

To allow others to use the YouTube integration I need to get approval from Google

Setup web server and HTTPS

https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-gunicorn-and-nginx-on-ubuntu-18-04

Improve UI

Choose number of items in reminder e-mail

Share favourites

Investigate the ability to share your imported items with others easily

Indicate whether importing already setup for a particular source

An import source should be grayed out when importing is already setup and background sync is ongoing

Automatic checking for new items to import

Once a particular source has been imported we should try to periodically check for updates from that source. Some code to do this in Pocket is shown below:

if not os.path.exists('pocket_access_token.pickle'):
    with open('pocket_access_token.pickle', 'wb') as token:
        pickle.dump(access_token, token)

sched.add_job(
        check_pocket_updates,
        kwargs={'user_id': current_user.id},
        trigger='interval',
        hours=1
 )

def check_pocket_updates(user_id):
    with open('pocket_access_token.pickle', 'rb') as token:
        access_token = pickle.load(token)

    data = {
        "access_token": access_token,
        "consumer_key": application.config['POCKET_CONSUMER_KEY'],
        "favorite": 1
    }
    response = requests.get("https://getpocket.com/v3/get/", json=data)
    favourites = [favourite for favourite in response.json()['list'].values()]

    add_items(user_id, favourites)