Gist synching

A note to current users

To enable this feature, please install module 'pygithub' first, by running the following command via terminal:

pip3 install pygithub

Feature is experimental. Please regularly backup your notes.sqlite database to avoid data loss.

Gist synching allows Bible chapter and verse notes to be synced between different computers. When gist synching is turned on, the Bible notes are stored on your computer and also on Github as a gist file.

To enable synching, turn on the enableGist config flag.

You will also need to generate a Github personal access token. Go to your profile, Developer Settings, Personal Access Tokens. Click Generate New Token. Enter your password. Enter the name of the token (eg. gist-access-token). Check "gist - Create gists". Click "Generate Token". It will generate a 40 character token. Save this token.

In the UBA, open the Gist menu item (under Notes in the classic menu and under Annotation in the aleph menu). Enter the Gist access token. Press the "Test Connection" button. It should then say it is connected to your account. Press the Synch Bibles Notes button. Depending on how many notes you have, it will take some time to sync.

You can view your gists at gist.github.com.

Since enabling the gist sync will cause all notes to be loaded and saved to Github, it will cause opening and saving notes to be slower than normal.

Bible Gists are publicly viewable. In the future, will add the ability to view and comment on Bible notes of others.

Commands

Print how many notes are in database: NOTES:::COUNT

Run sync of Bibles notes: SYNC:::NOTES

Delete all Bibles notes in Github: GIST:::DELETE:::NOTES