Hey I am Lupin, an Open Source Telegram Python Chat Bot build to supercharge your LogSeq with great features like Interstitial Journaling | Flashcards | Brainmaps | PDF / Web Annotations | {TODO; DOING; LATER} | Bookmarks | Images upload and more
Assuming you are already using LogSeq & are familar with Python.
Lupin requires Python version >= 3.x
- Clone me
git clone https://github.com/akhater/Lupin
- Create a telegram bot
- Install Python Telegram Bot library using
pip install python-telegram-bot
orpip3 install python-telegram-bot
- Install PyGithub library using
pip install pyGitHub
orpip3 install pyGitHub
- Install the
requests
library usingpip install requests
orpip3 install requests
- Generate a Github token from
https://github.com/settings/tokens
- Rename
config.sample.ini
toconfig.ini
- Change values in
config.ini
to fit your environment - Run the bot using
python main.py
orpython3 main.py
- Privacy always - self hosted & open source
- Security
- Entries are only accepted from telegram BotAuthorizedIDs so not anyone can add entries to your journal
- Fully customization with config.ini file
- Rename it
- Translate it (no hard coded messages)
- much more
- Send a thought (any text) and Lupin will make your Interstitial Journaling a breeze
- Timestamp it: supporting both 12 and 24 hrs format
- You can also turn off the timestamp all together if that's what you want
- Enter it in your Github hosted Jounral
- Send your TODO list (by including TODO in the text) and Lupin will convert it to a LogSeq TODO
- TODO command is customizable
- Send a link and Lupin automatically create a #bookmark entry in your Journal in the form of
- 18:48 #bookmark title
- #bookmark tag is customizable
- Send a YouTube video link and Lupin will automatically embedded in your Journal in the form of
- 18:52 {{Youtube link}}
- Send
/anno uri
to import all your annotations from for the uri from Hypothesis - Support for both LogSeq regular Journal and custom Journal folder and/or file
- Spaced Repetion: Spaced Repetition capabilities based on SuperMemo2 Algorithm
- Calendar Generation: Auto generates PiotrSss calendar and puts them in the sidebar
- Theme Switcher: Switch between multiple themes by calling /themes
- Generate Mindmaps of your pages by called /getMM PageTitle
- Support for AGE encryption and encrypted Graphs
Supported format for flaschards is
## #flashcardtag
### Question 1
#### answer line 1
#### answer line 2
### Question 2
#### Answer 2
Flashcard tag is customizable Algorithm used is SuperMemo2 Triggers are /tsr import --> scan - import - update your flashcards /tsr x -> retrieve x flashcards from you pending pool /tsr -> retrieve the default number of cards set in your config .ini file Below entry in config.ini specifies you default number of flashcards
[TimeSpacedRepetion]
flashcardDailyGoal=10
Before being able to use this feature you need to name your various themes in the format ThemeName.custom.css
and place them in the /logseq folder
Command | Description |
---|---|
/start | Just a greeting |
/uptime | returns Lupin Uptime |
/ver | returns Lupin running Version |
/help | help command (WIP) |
/anno URL | Import hypothesis annotations from URL |
/importFC | Imports your Flashcards into Lupin |
/srs import | alias of /importFC |
/srs x | starts a round of SRS for x flashcards |
/getMM pageTitle | Generates a dynamic MindMap for pageTitle |
/pullNow | Pulls all pages from your Git for fast access |
/themes | calls the theme changer |
/encryptAll | Encrypts all your pages with AGE keys |
/decryptAll | Decrypts all your pages back to clear text |
Imported Hypothesis notes into LogSeq