Skip to main content

Tool to learn from your org-mode notes

Project description

GitHub

Orglearn

Orglean provides tools for learning from org-mode notes. It can generate mind maps and anki decks.

Anki

Convert org to anki deck. The convertor will take all leafs of the tree (nodes without children) and convert them into an anki card. The node title is front-side of the card and the body is the back-side of the card.

Mind map

TBD

PDF

Orglearn is able to create pdf from your notes. You can achieve similar results converting org files to pdf using emacs. But we think that using pandoc results in better looking pdfs.

To be able to convert org files to pdf you need to have pandoc installed on your system.

Instalation

python -m venv env # In case you want to install in virtualenv.
. env/bin/activate
pip install .

Usage

Below are some basic examples for running orglearn:

orglearn anki file1.org # Convert org file into anki deck ./file1.apkg
orglearn anki file1.org file2.org # Convert multiple files into single deck

Contributing

Contribution guidelines TBD.

We are using the black for the source code formatting. To use it automatically preprare pre-commit hooks with the following command.

pre-commit install # Install the pre-commit hooks

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for orglearn, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size orglearn-1.0.0-py3-none-any.whl (9.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size orglearn-1.0.0.tar.gz (7.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page