<h1 align="center">BookGPT (Beta)</h1>
<p align="center">This program uses the GPT-3 API to generate books based on your specified parameters.
<br><br>
</p>
## 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:
```bash
git clone https://github.com/mikavehns/BookGPT.git
```
2. Navigate to the root directory of the repository using `cd BookGPT/src`
3. Install the required dependencies by running the following command:
```bash
pip install -r requirements.txt
```
## Prerequisites
In order to use this program, you must have a [GPT-3 API key](https://beta.openai.com/account/api-keys). 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:
```bash
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 in the `books` folder and will be named after the title of the book.
## Examples
Here are some examples:
- Generate book with 5 chapters and 300 words per chapter, with quotes as chapter title, with the topic "success":
https://user-images.githubusercontent.com/66560242/210459589-751c82d7-e874-4119-a09a-cc36ea2be73c.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 GPT-3 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.6.2), there are many missing features, that will be added by time
## License
This project is licensed under the MIT License - see the [LICENSE](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](https://github.com/mikavehns/BookGPT).
- 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.
Raw data
{
"_id": null,
"home_page": "",
"name": "bookgpt",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,gpt-3,openai,book,generator,writer",
"author": "Mika Vehns",
"author_email": "<mika.vehns@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/c5/99/c51594c83844c6a39e2648ace0f2d165d257af848e133986799d6cf1a8e2/bookgpt-0.6.2.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">BookGPT (Beta)</h1>\n\n<p align=\"center\">This program uses the GPT-3 API to generate books based on your specified parameters.\n\n<br><br>\n\n</p>\n\n\n\n\n\n## Installation\n\nTo install this program, simply follow these steps:\n\n1. Clone this repository to your local machine by running the following command in your terminal:\n\n```bash\n\ngit clone https://github.com/mikavehns/BookGPT.git\n\n```\n\n2. Navigate to the root directory of the repository using `cd BookGPT/src`\n\n3. Install the required dependencies by running the following command:\n\n```bash\n\npip install -r requirements.txt\n\n```\n\n\n\n\n\n## Prerequisites\n\nIn order to use this program, you must have a [GPT-3 API key](https://beta.openai.com/account/api-keys). The API Key must then be inserted into the `config.json` file.\n\n\n\n\n\n## Usage\n\nTo use this program, simply run the following command in your terminal:\n\n```bash\n\npython run.py\n\n```\n\nYou will then be prompted to enter the following information:\n\n- Chapter Amount: The amount of chapters you want the book to have.\n\n- Chapter Length: The amount of words you want each chapter to have.\n\n- Topic: The topic you want the book to be about.\n\n- Category: The type of book you want to generate. (Science, Biography, etc.)\n\n\n\nThe program will then generate a Title and Chapter Titles + Content. You will get a detailed structure of the book.\n\nThe generated books will then be saved in the `books` folder and will be named after the title of the book.\n\n\n\n\n\n## Examples\n\nHere are some examples:\n\n- Generate book with 5 chapters and 300 words per chapter, with quotes as chapter title, with the topic \"success\":\n\n\n\nhttps://user-images.githubusercontent.com/66560242/210459589-751c82d7-e874-4119-a09a-cc36ea2be73c.mp4\n\n\n\n- You can see all examples in the `examples/` directory.\n\n\n\n\n\n## Notes\n\n- 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.\n\n- The program may take some time to run, depending on the specified parameters and the performance of the GPT-3 API. Please be patient while the book is being generated.\n\n- 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.\n\n- Currently, it is only possible to generate Non-Fiction books.\n\n- Since this is a really early version (v0.6.2), there are many missing features, that will be added by time\n\n\n\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n\n\n\n\n## Contributing\n\n- 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](https://github.com/mikavehns/BookGPT).\n\n- 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.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Generating books using OpenAI's GPT-3 API.",
"version": "0.6.2.1",
"split_keywords": [
"python",
"gpt-3",
"openai",
"book",
"generator",
"writer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f073c5c83bb587258d5624f162f5411c8cb28b891cc2a9e483cc04987d49b5d",
"md5": "48a2e988727c988324ddddb5c304af49",
"sha256": "eca4af942371483afed7b62bac574d200928541b44cedce9cf4b3bafef124f3c"
},
"downloads": -1,
"filename": "bookgpt-0.6.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48a2e988727c988324ddddb5c304af49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 17440,
"upload_time": "2023-01-08T17:06:48",
"upload_time_iso_8601": "2023-01-08T17:06:48.107732Z",
"url": "https://files.pythonhosted.org/packages/1f/07/3c5c83bb587258d5624f162f5411c8cb28b891cc2a9e483cc04987d49b5d/bookgpt-0.6.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c599c51594c83844c6a39e2648ace0f2d165d257af848e133986799d6cf1a8e2",
"md5": "c87329d25f667f457c9f289d321e6abc",
"sha256": "fdebee1117c78616e27ef2ef021495d0e4f550c9b228bc66cd0fb9409b7442f0"
},
"downloads": -1,
"filename": "bookgpt-0.6.2.1.tar.gz",
"has_sig": false,
"md5_digest": "c87329d25f667f457c9f289d321e6abc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10068,
"upload_time": "2023-01-08T17:06:49",
"upload_time_iso_8601": "2023-01-08T17:06:49.895371Z",
"url": "https://files.pythonhosted.org/packages/c5/99/c51594c83844c6a39e2648ace0f2d165d257af848e133986799d6cf1a8e2/bookgpt-0.6.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-08 17:06:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "bookgpt"
}
JSON