Skip to main content

Authoring Framework — domain schemas and orchestration base for AI-assisted creative writing

Project description

authoringfw — Authoring Framework

Domain schemas for AI-assisted creative writing applications.

Installation

pip install authoringfw

Quick Start

from authoringfw import StyleProfile, CharacterProfile, WorldContext, get_format

# Style constraints for prompt injection
style = StyleProfile(tone="melancholic", pov="third_limited", tense="past")
constraints = style.to_constraints()

# Character context
alice = CharacterProfile(
    name="Alice",
    role="protagonist",
    personality_traits=["brave", "curious"],
    arc="From fear to courage",
)
print(alice.to_context_string())

# World context
world = WorldContext(
    title="The Shattered Realms",
    genre="fantasy",
    world_rules=["Magic costs life force", "Dragons are extinct"],
)
print(world.to_context_string())

# Format profiles (novel, essay, series, scientific)
roman = get_format("roman")
print(roman.style_constraints)

Schemas

  • StyleProfile — tone, POV, tense, vocabulary, sentence rhythm
  • CharacterProfile — name, role, traits, backstory, arc, relationships
  • WorldContext — title, genre, setting, world rules, locations, lore
  • VersionMetadata — immutable content snapshot with hash, semver, LLM metadata
  • PhaseSnapshot — project state at a workflow phase boundary

Format Profiles

Built-in formats: roman, essay, serie, scientific

from authoringfw.formats.base import get_format, WorkflowPhase

novel = get_format("roman")
outline_steps = novel.steps_for_phase(WorkflowPhase.OUTLINE)

Adapter Interfaces

Protocol-based adapters — no inheritance required:

from authoringfw.adapters.interfaces import IStyleAdapter

class MyStyleAdapter:
    async def get_profile(self, style_id): ...
    async def analyze_text(self, text): ...
    def generate_style_constraints(self, profile): ...
    async def score_conformity(self, text, profile): ...

adapter = MyStyleAdapter()
assert isinstance(adapter, IStyleAdapter)  # True via @runtime_checkable

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

iil_authoringfw-0.10.0.tar.gz (52.2 kB view details)

Uploaded Source

Built Distribution

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

iil_authoringfw-0.10.0-py3-none-any.whl (46.3 kB view details)

Uploaded Python 3

File details

Details for the file iil_authoringfw-0.10.0.tar.gz.

File metadata

  • Download URL: iil_authoringfw-0.10.0.tar.gz
  • Upload date:
  • Size: 52.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for iil_authoringfw-0.10.0.tar.gz
Algorithm Hash digest
SHA256 6c0209412ae5546b4812a0aed003e395473661539f4216f84a8732df44f63bb8
MD5 343b55ff425510dd3059aca1fe9a8696
BLAKE2b-256 ac319aaab2e898b789b5f34881ebf3cd623104f3b0cc095ab7badcea96905d5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_authoringfw-0.10.0.tar.gz:

Publisher: publish.yml on achimdehnert/authoringfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file iil_authoringfw-0.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for iil_authoringfw-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f0e9c2dfe5e8f2b190a65e5d8402b59910312382c75713c71a739363cdeed16
MD5 12f3de712fb21195325201ad3ef59f89
BLAKE2b-256 07c363beca2bb9e4dde7a81affe22e24f59c2ebe3c9191da6cd101f2da6a7d23

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_authoringfw-0.10.0-py3-none-any.whl:

Publisher: publish.yml on achimdehnert/authoringfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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