Skip to content

A project for Powered By Sefaria Contest, Summer 2020

License

Notifications You must be signed in to change notification settings

jmcaplan/sefariaExtension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

I'm Learning Lucky | Google Chrome Extension

A project for Powered By Sefaria Contest, Summer 2020

About

Concept

This project is a Chrome browser extension for sefaria.org, that utilizes the Sefaria API to raise fun insights while studying a text on the platform.

  • The first feature, called 'Jastrow Jackpot,' allows the user to search a Hebrew/Aramaic word in the Jastrow Aramaic Dictionary, and receive not only the relevant definitions, but also a special message if the user has stumbled upon a 'Jastrow Jackpot' - when an example of the word's usage that the dictionary references matches the source currently being learned (in this case, the source one has open in sefaria.org).
  • The second feature, called 'Timely Texts,' allows the user to check if the text they currently have open is linked to any of the 'Timely Texts,' i.e. the texts that relate to the current calendar date (e.g. the Daf Yomi of that day, or the Parashat Hashavua of that week). It is only present in version 3 (v3).

Versions

There are three versions of the extension. Version 1 (v1) is more 'raw' but also slightly faster. Version 2 (v2) has a nicer look but takes a bit longer to render. Version 3 (v3) is essentially identical to v2, with the addition of the 'Timely Texts' feature.

How to install

To install the extension, open a Chrome browser and go to chrome://extensions/ and click on 'Load unpacked'. For the folder, choose the appropriate folder from this repository, e.g. v1/chrome_extension

How to use (Jastrow Jackpot)

Go to the sefaria website and open a text (for example, this passage in Tractate Shabbat). Then open the extension:

Find Extension

Version 1 Interface

Type in the hebrew word you wish to search, and click 'Search'. You should see the Jastrow Dictionary definitions relevant to your query, along with functional links to Sefaria pages. If you are lucky enough, you might just stumble upon a 'Jastrow Jackpot':

Successful Jackpot

Version 2 Interface

In this version, the search result will appear as an iframe of Sefaria's website:

Successful Jackpot V2

How to use (Timely Texts)

With the extension open, click on 'Check Timely Texts' to see if the source currently open is related to any 'Timely Texts.' After the results appear, click 'Clear Timely Texts results' to restart.

Successful Timely Texts

Technical Architecture

Sefaria APIs

  • The 'Jastrow Jackpot' feature utilizes the Lexicon API
  • The 'Timely Texts' feature utilizes the Links API

AWS Integration

  • All features work by having the Javascript in the Chrome extension make calls to API Gateway endpoints, which trigger Lambda functions written in Python (3.7) which in turn use the 'requests' library to call the Sefaria APIs (NOTE - this library is currently imported from the built-in botocore.vendored library, and will be depracated January 2021, at which time the library will have to be manually injected).

About

A project for Powered By Sefaria Contest, Summer 2020

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published