Skip to content

Latest commit

 

History

History
49 lines (41 loc) · 2.75 KB

README.md

File metadata and controls

49 lines (41 loc) · 2.75 KB
Raw

Autocards

  • Automatically create questions and answers from various input formats (PDF files, webpages, epub files, etc) then export them into your favorite flashcards software (like anki or SuperMemo)
  • To see a real world example, the complete output of this article can be found in this folder. It's the direct output with no post processing whatsoever.
  • Code is PEP compliant and with docstrings. Contributions and PR are extremely appreciated
  • Learn more by reading the official write-up. =======
  • Automatically create questions and answers from various input formats (PDF files, webpages, wikipedia, epub files, etc) then export them into your favorite flashcards software (like anki or SuperMemo)
  • To see a real world example, the complete output of this article can be found in this folder. It's the direct output with no post processing whatsoever.
  • Code is PEP compliant and with docstrings. Contributions and PR are extremely appreciated
  • Learn more by reading the official write-up.

Install guide:

  • git clone https//github.com/Psionica/Autocards
  • cd Autocards
  • pip install -r ./requirements.txt
  • open a python console: ipython3
  • install punkt by running !python -m nltk.downloader punkt

Autocards usage

# loading
from autocards import Autocards
a = Autocards(in_lang="any", out_lang="ru")  # translation modules sometimes need to be downloaded and can be rather large

# eating the input text using one of the following ways:
a.consume_var(my_text, per_paragraph=True)
a.consume_user_input(title="")
a.consume_textfile(filename, per_paragraph=True)
a.consume_pdf(pdf_path, per_paragraph=True)
a.consume_web(source, mode="url", element="p")
# =>  * element is the html element, like p for paragraph
#     * mode can be "url" or "local"

# three ways to get the results back: printing, pandas, export
out = a.string_output(prefix='', jeopardy=False)
#    =>  * prefix is a text that will be appended before the qa
#        * jeopardy is when switching question and answer
a.print(prefix='', jeopardy=False)
a.pprint(prefix='', jeopardy=False)  # pretty printing
df = a.pandas_df(prefix='')
a.to_csv("output.csv", prefix="")
a.to_json("output.json", prefix="")
a.to_anki(deckname="autocards_export", tags="some_tag")

# Also note that a user provided his own terrible scripts that you can get inspiration from, they are located in the folder `examples_script`