Skip to main content

GPTAuthor is a tool for writing long form stories using AI

Project description

GPT Author

Latest Tag Build

GPTAuthor is a tool for writing long form, multi-chapter stories and novels using AI

A GPT human cybord writing a manuscript

Installation

You can install llmgraph using pip:

pip install gptauthor

Usage

Example Usage

This example reads the story prompt from the example file prompts-openai-drama.yaml file and writes 3 chapters using the gpt-3.5-turbo model with a temperature of 0.1:

export OPENAI_API_KEY=sk-<your key>
gptauthor --story openai-drama --total-chapters 3 --llm-model gpt-3.5-turbo --llm-temperature 0.1

Required Arguments

  • --story TEXT: The name within the yaml file name defining the story [default: openai-drama]

Optional Arguments

  • --llm-model TEXT: The model name [default: gpt-3.5-turbo]
  • --llm-temperature FLOAT: LLM temperature value (0 to 2, OpenAI default is 1) [default: 1]
  • --llm-top-p FLOAT: LLM top_p probability value (0 to 2, OpenAI default is 1) [default: 1]
  • --llm-use-localhost INTEGER: LLM use localhost:8081 instead of openai [default: 0]
  • --total-chapters INTEGER: Total chapters to write [default: 5]
  • --allow-user-input / --no-allow-user-input: Allow command line user input [default: allow-user-input]
  • --version: Display gptauthor version
  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Produced Output Files

While running the app tells your the input paramers, the progress of the writing, and where the output is written to.

In progress and final output is written to the ./_output/ directory, in the sub-folders ./_output/<prompt-file-name>/<model-name>/<datetime>-<parameters>-<book-name>/.

There are several files, the main output being a Markdown version of the whole book _whole_book.md and an HTML version of the same _whole_book.html.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gptauthor-0.2.0.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gptauthor-0.2.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file gptauthor-0.2.0.tar.gz.

File metadata

  • Download URL: gptauthor-0.2.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.6 Darwin/22.5.0

File hashes

Hashes for gptauthor-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a5df350dcc52316e5c3a3b344f87c09a8986e7e8ddd78c931b49faf86ae3734b
MD5 4e42acfcbdcdda106266e96dc5dcd0da
BLAKE2b-256 c7091a69076e9afcd64845186f047095240f152975b776e385ea7ff4341844b2

See more details on using hashes here.

File details

Details for the file gptauthor-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: gptauthor-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.6 Darwin/22.5.0

File hashes

Hashes for gptauthor-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a7d953c2a18baa828e77a3ce132711aaf71e259e2c78e8957cf3ea68570bc44
MD5 fe10deb2a4590f1e734c8d1295dfa1f8
BLAKE2b-256 93a65a255e92920a86717b60281c3e983ec76808feecd6591f8c4e159539a724

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page