github/bilingual_book_maker
1
1
Fork 0
mirror of https://github.com/yihong0618/bilingual_book_maker.git synced 2025-06-02 09:30:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
bilingual_book_maker/docs/quickstart.md
YYLIZH c7ee4acb14
Add formal doc page (#319) 
* fix readme

* done
2023-08-15 09:41:13 +08:00

1.2 KiB
Raw Blame History

QuickStart

After successfully install the package, you can see bbook-maker is in the output of pip list.

Preparation

  1. ChatGPT or OpenAI token
  2. epub/txt books
  3. Environment with internet access or proxy
  4. Python 3.8+

Use

You can use by command bbook_maker. A sample book, test_books/animal_farm.epub, is provided for testing purposes.

bbook_maker --book_name ${path of a book} --openai_key ${openai_key}

# Example
bbook_maker --book_name test_books/animal_farm.epub --openai_key ${openai_key}

Or, you can use the script provided by repository.

python3 make_book.py --book_name ${path of a book} --openai_key ${openai_key}

# Example
python3 make_book.py --book_name test_books/animal_farm.epub --openai_key ${openai_key}

Once the translation is complete, a bilingual book named ${book_name}_bilingual.epub would be generated.

Note: If there are any errors or you wish to interrupt the translation by pressing CTRL+C. A book named ${book_name}_bilingual_temp.epub would be generated. You can simply rename it to any desired name.