Metadata-Version: 2.1
Name: jankigen
Version: 0.1.6
Summary: Generate Anki decks from Japanese text
Home-page: UNKNOWN
License: UNKNOWN
Description: ## JANKIGEN
        
        Generate Anki decks from Japanese text
        
        #### Features
        - CLI and GUI
        - Generate decks from directories
        - Generate deck from single text file
        - Card order is shuffled to prevent text understanding (enabled by default)
        - Kanji card and Word cards
        - Kanji cards are ordered to be before corresponding word cards
        - Custom user dictionaries
        
        #### Limitations/Known issues
        - It is sloooow (some library i'm using don't fit this purpose, there is quite a work to do for this)
        
        #### Requirements
        - Python 3.7+
        
        #### Install
        
        ```bash
        pip install jankigen
        ```
        
        #### Example commands:
        
        ```bash
        # Decks are generated in the same folder of the parsed file/directory
        
        # Run GUI mode
        jankigen
        
        # Generate one anki deck for this file
        jankigen text_file.txt
        
        # Generate one anki deck for each file
        jankigen directory_with_txts --disable_shuffle_card --enable_deck_per_text_file --disable_gen_global_deck_for_all_files
        
        ```
        
        ```
        jankigen --help
        
        usage: jankigen [-h] [--disable_shuffle_card [DISABLE_SHUFFLE_CARD]] [--enable_deck_per_text_file [ENABLE_DECK_PER_TEXT_FILE]]
                        [--disable_gen_global_deck_for_all_files [DISABLE_GEN_GLOBAL_DECK_FOR_ALL_FILES]]
                        [--user_dict USER_DICT] [--user_dict_en USER_DICT_EN]
                        path
        
        Generate anki deck from file
        
        positional arguments:
          path                  File or directory with text files
        
        optional arguments:
          -h, --help            show this help message and exit
          --disable_shuffle_card [DISABLE_SHUFFLE_CARD]
                                Shuffles cards to prevent text understanding/spoiler
          --enable_deck_per_text_file [ENABLE_DECK_PER_TEXT_FILE]
                                If searching in a directory, create an anki file for each text file found
          --disable_gen_global_deck_for_all_files [DISABLE_GEN_GLOBAL_DECK_FOR_ALL_FILES]
                                Generate a global deck for all text files
          --user_dict USER_DICT
                                Simplified janome dictionary. A csv file as <surface form>,<part-of-speech>,<reading>
          --user_dict_en USER_DICT_EN
                                Match entries of user_dict with corresponding translations. <surface
                                form>,<reading>,<english_translation>
        
        ```
        
        ### Build
        
        ```
        python presetup.py
        python setup.py sdist
        ```
Platform: UNKNOWN
Description-Content-Type: text/markdown
