Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Tool to learn from your org-mode notes

Project description

GitHub

Orglearn

Orglean provides toolbox for learning from your org-mode notes. It can generate mind maps, anki decks and even pdfs textbooks.

Modes [commands]

Anki

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

Mind map

Convert notes into a mid map. This is a good way to visualize the relationships between each node.

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 and gives us the best way to customize the result.

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

Instalation

The latest stable release of orglearn can be obtained via pypi:

pip install orglearn

If you wish to install the latest master branch:

git clone https://github.com/MatejKastak/orglearn && cd orglearn
python -m venv env && . env/bin/activate # In case you want to install in virtualenv.
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

Constributions are highly appreciated. If you choose to contribute please read the 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.11
Filename, size File type Python version Upload date Hashes
Filename, size orglearn-1.0.11-py3-none-any.whl (13.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size orglearn-1.0.11.tar.gz (11.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page