Skip to content

Writes complete books with given paramters, using GPT-3.

License

Notifications You must be signed in to change notification settings

mikavehns/BookGPT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

61 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BookGPT (Beta)

This program uses the ChatGPT API to generate books based on your specified parameters.

Installation

To install this program, simply follow these steps:

  1. Clone this repository to your local machine by running the following command in your terminal:
git clone https://github.com/mikavehns/BookGPT.git
  1. Navigate to the root directory of the repository using cd BookGPT
  2. Install the required dependencies by running the following command:
pip install -r requirements.txt

Prerequisites

In order to use this program, you must have a ChatGPT API key. The API Key must then be inserted into the config.json file.

Usage

To use this program, simply run the following command in your terminal:

python run.py

You will then be prompted to enter the following information:

  • Chapter Amount: The amount of chapters you want the book to have.
  • Chapter Length: The amount of words you want each chapter to have.
  • Topic: The topic you want the book to be about.
  • Category: The type of book you want to generate. (Science, Biography, etc.)

The program will then generate a Title and Chapter Titles + Content. You will get a detailed structure of the book. The generated books will then be saved as book.md in BookGPT/src.

Examples

Here are some examples:

  • Generate book with 5 chapters and 300 words per chapter, with quotes as chapter title, with the topic "success":
the_path_to_success.mp4
  • You can see all examples in the examples/ directory.

Notes

  • The run.py file is just one example on how to use the book generator. You can also implement it into a website, discord bot, desktop app, etc.
  • The program may take some time to run, depending on the specified parameters and the performance of the ChatGPT API. Please be patient while the book is being generated.
  • The program may not always generate the wished amount of words for each chapter. This can happen, if there is not enough data available for the specified topic.
  • Currently, it is only possible to generate Non-Fiction books.
  • Since this is a really early version (v0.8.0), there are many missing features, that will be added by time

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

  • If you are interested in contributing to BookGPT, I welcome any suggestions or pull requests. Please feel free to open an issue or submit a pull request on the GitHub repository.
  • You can also submit your books, which I will then add to the examples folder. Just open a pull request with the book in the examples folder.

About

Writes complete books with given paramters, using GPT-3.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages