Code Monkey home page Code Monkey logo

alfred-readwise's Introduction

alfred-readwise

An Alfred Workflow for your Readwise account

Downloads

Motivation ✅

  • Quickly list, search, and open your Readwise highlights
  • Add new highlights to your account through Alfred

Setting up ⚙️

Needed

Default settings

  • In Alfred, open the 'Configure Workflow' menu in alfred-readwise preferences
    • set the keyword for the workflow (default: !r)
    • set the keyword to force refresh (default: readwise:refresh)
    • set the Readwise API token (login into your account, then copy it here)
    • set what to show in results: books, tweets, supplementals, articles, podcasts
    • set refresh rate (in days). Default: 30
    • set 'book' name from highlights entered via Alfred. Default: Highlights from Alfred
    • set search scope:
      • Highlight: search highlight text only
      • Book: search book titles only
      • Both (default): search across highlights and book titles

Basic Usage 📖

Searching your Readwise database 🔍

  • launch with keyword (default: !r), or custom hotkey
  • standard search will be through highlight text and book titles. Multiple word (fragments) supported
  • typing # will prompt a label search which can be added to the standard search, multiple labels supported
    • enter ↩️ will show the highlight in large font and copy to clipboard
    • shift-enter ⇧↩️ will show the highlight in large font and copy to clipboard without closing Alfred
    • command-enter ⌘↩️ will open the source URL if available (typically for tweets)
    • ctrl-enter ^↩️ will open the highlight on Readwise
    • shift-ctrl-enter ⇧^↩️ will open all highlights from that book on Readwise
    • shift alone: Quicklook of your highlight.

Entering new highlights ⭐

  • Universal Action: new highlights can be created by selecting text in any app, then launching Universal Actions and selecting Create a new Readwise highlight. The corresponding text will be assigned to a 'book' titled as set in alfred-readwise preferences (default: Highlights from Alfred).

Database refresh 🔄

  • will occur according to the rate in days set in alfred-readwise preferences, or...
    • readwise:refresh to force database refresh

Limitations & known issues ⚠️

  • None for now, but I have not done extensive testing, let me know if you see anything!

Acknowledgments 😀

Changelog 🧰

  • 04-04-2023: version 0.1

Feedback 🧐

Feedback welcome! If you notice a bug, or have ideas for new features, please feel free to get in touch either here, or on the Alfred forum.

alfred-readwise's People

Contributors

giovannicoppola avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

alfred-readwise's Issues

Not Working - Bug Report Included

Thanks for what will be a very useful workflow ! I've installed it and configured to access my readwise account, but am getting an the following error log. Any suggestions on what I should do to resolve it would be welcomed. FYI - All my workflows are in Dropbox and I have Python 3.1 installed.

[09:54:15.942] ERROR: alfred-readwise[Script Filter] Code 1: 0 days from last update
Traceback (most recent call last):
File "/Users/USER/Library/CloudStorage/Dropbox/=Personal (Philip)/Philip's Apps/Alfred/Alfred.alfredpreferences/workflows/user.workflow.941488C4-346C-422A-9F9B-FC03B24816DD/readwise-query.py", line 217, in
main ()
File "/Users/USER/Library/CloudStorage/Dropbox/=Personal (Philip)/Philip's Apps/Alfred/Alfred.alfredpreferences/workflows/user.workflow.941488C4-346C-422A-9F9B-FC03B24816DD/readwise-query.py", line 212, in main
queryItems (MY_DATABASE, MYINPUT)
File "/Users/USER/Library/CloudStorage/Dropbox/=Personal (Philip)/Philip's Apps/Alfred/Alfred.alfredpreferences/workflows/user.workflow.941488C4-346C-422A-9F9B-FC03B24816DD/readwise-query.py", line 53, in queryItems
tag_rows = db.execute(tag_statement).fetchall()
^^^^^^^^^^^^^^^^^^^^^^^^^
sqlite3.OperationalError: no such table: tags

Return to List

Thank you for putting together this workflow! I was hoping something like this existed for Alfred.

What stands out to me, however, is how much text I want to read for each highlight, far more than exists on each line, simply to bring it back to mind. I could hit the return key and then read it in large type, but then escaping from the large type would not bring me back to the highlights list. I naively tried quicklook (despite each highlight not being its own file), but no luck. Any suggestions?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.