Name | bruhbook JSON |
Version |
1.0.17
JSON |
| download |
home_page | |
Summary | |
upload_time | 2024-02-05 03:10:33 |
maintainer | |
docs_url | None |
author | ethanlchristensen |
requires_python | >=3.11,<4.0 |
license | |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# BruhBook
`bruhbook` is a Python package designed to interface with OpenAI, allowing users to create captivating short stories complete with custom cover art. This tool is perfect for writers, creators, and anyone interested in generating unique narratives with visually appealing covers.
## Features
- Generate short stories based on specific themes and target audiences.
- Automatically create cover art for the stories.
- Customizable story generation to suit different genres and styles.
## Installation
To install `bruhbook`, simply run:
```bash
pip install bruhbook
```
## Usage
Here is a basic example of how to use `bruhbook` to generate a short story with a cover image:
```py
from bruhbook.bruhbook import BruhBook
bb = BruhBook(
create_cover_image=True,
wipe_files=False
)
story_type = "A cyberpunk knight fighting his way through hell. Flames, lava, dark, alien like plasma monsters"
target_audience = "Mature Adults"
bb.generate_story_outline(
story_type=story_type,
target_audience=target_audience
)
bb.story_generator(
story_type=story_type,
target_audience=target_audience
)
```
## Requirements
- Python 3.11 or later
## Documentation
🚧 Under Construciton 🚧
## Contributing
🚧 Under Construction 🚧
## License
`bruhbook` is licensed under the Apache License. See the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "bruhbook",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "ethanlchristensen",
"author_email": "ethanlchristensen@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/a7/b7/69fc4458ada2082798d8dfd3eb917257010131fc2e588e913977fda2c49c/bruhbook-1.0.17.tar.gz",
"platform": null,
"description": "# BruhBook\n\n`bruhbook` is a Python package designed to interface with OpenAI, allowing users to create captivating short stories complete with custom cover art. This tool is perfect for writers, creators, and anyone interested in generating unique narratives with visually appealing covers.\n\n## Features\n\n- Generate short stories based on specific themes and target audiences.\n- Automatically create cover art for the stories.\n- Customizable story generation to suit different genres and styles.\n\n## Installation\n\nTo install `bruhbook`, simply run:\n\n```bash\npip install bruhbook\n```\n\n## Usage\n\nHere is a basic example of how to use `bruhbook` to generate a short story with a cover image:\n\n```py\nfrom bruhbook.bruhbook import BruhBook\n\nbb = BruhBook(\n create_cover_image=True,\n wipe_files=False\n)\n\nstory_type = \"A cyberpunk knight fighting his way through hell. Flames, lava, dark, alien like plasma monsters\"\ntarget_audience = \"Mature Adults\"\n\nbb.generate_story_outline(\n story_type=story_type,\n target_audience=target_audience\n)\n\nbb.story_generator(\n story_type=story_type,\n target_audience=target_audience\n)\n```\n\n## Requirements\n\n- Python 3.11 or later\n\n## Documentation\n\n\ud83d\udea7 Under Construciton \ud83d\udea7\n\n## Contributing\n\n\ud83d\udea7 Under Construction \ud83d\udea7\n\n## License\n\n`bruhbook` is licensed under the Apache License. See the [LICENSE](LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": "",
"summary": "",
"version": "1.0.17",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "822f21b2c8327ed17a9bf5a533547b0e801b25d777a2afe8c3610287b2b97429",
"md5": "eb2a648e4e5942cd3579a22a53bac215",
"sha256": "93c25c639018c0e0789620cc4a5748fc5f8354abb0c00dcc151937f76602e983"
},
"downloads": -1,
"filename": "bruhbook-1.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb2a648e4e5942cd3579a22a53bac215",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 12764,
"upload_time": "2024-02-05T03:10:32",
"upload_time_iso_8601": "2024-02-05T03:10:32.017454Z",
"url": "https://files.pythonhosted.org/packages/82/2f/21b2c8327ed17a9bf5a533547b0e801b25d777a2afe8c3610287b2b97429/bruhbook-1.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a7b769fc4458ada2082798d8dfd3eb917257010131fc2e588e913977fda2c49c",
"md5": "b1099bd7a2197ed32dde16ee570c167b",
"sha256": "5fb39a8922876e8347651e15614cf6d8f6a4862b9ab833f3e4732b14ae84536b"
},
"downloads": -1,
"filename": "bruhbook-1.0.17.tar.gz",
"has_sig": false,
"md5_digest": "b1099bd7a2197ed32dde16ee570c167b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 12043,
"upload_time": "2024-02-05T03:10:33",
"upload_time_iso_8601": "2024-02-05T03:10:33.510087Z",
"url": "https://files.pythonhosted.org/packages/a7/b7/69fc4458ada2082798d8dfd3eb917257010131fc2e588e913977fda2c49c/bruhbook-1.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 03:10:33",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "bruhbook"
}