Metadata-Version: 2.1
Name: orglearn
Version: 1.1.1
Summary: Tool to learn from your org-mode notes
Home-page: https://github.com/MatejKastak/orglearn
Author: Matej Kastak
Author-email: matej.kastak@gmail.com
License: MIT
Description: [![GitHub](https://img.shields.io/github/license/MatejKastak/orglearn?style=flat-square)](https://github.com/MatejKastak/orglearn/blob/master/LICENSE)
        
        # Orglearn
        
        Orglearn 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 converter 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](https://en.wikipedia.org/wiki/Mind_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` along with `pdflatex` installed on
        your system.
        
        ## Installation
        
        The latest stable release of `orglearn` can be obtained via `pypi`:
        ```sh
        pip install orglearn
        ```
        
        If you wish to install the latest `master` branch:
        
        ```sh
        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:
        
        ```sh
        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
        
        Contributions are highly appreciated. If you choose to contribute please read the Contribution Guidelines (TBD).
        
        We are using the [black](https://github.com/psf/black) for the source code
        formatting. To use it automatically prepare pre-commit hooks with the following
        command.
        
        ```sh
        pre-commit install # Install the pre-commit hooks
        ```
        
        ### Tests
        
        Use the following command to run tests:
        
        ```bash
        make test
        ```
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License 
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Education
Description-Content-Type: text/markdown
Provides-Extra: all
Provides-Extra: dev
