Skip to main content

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

Project description

iil-authoringfw — Authoring Framework

Domain schemas for AI-assisted creative writing applications.

PyPI Python License: MIT

Installation

pip install iil-authoringfw
# With aifw LLM integration:
pip install "iil-authoringfw[aifw]"
# All optional dependencies:
pip install "iil-authoringfw[all]"

Extras / Optional Dependencies

Extra Dependencies Purpose
aifw iil-aifw>=0.11.4 LLM completion integration (quality_level/priority routing needs >=0.11.2)
yaml pyyaml>=6.0 YAML template loading
promptfw iil-promptfw>=0.5.5 Prompt template rendering
all all above Full feature set

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 (alias novel), essay, serie, scientific, nonfiction, academic, screenplay, short_story, blog_post, podcast_script. The registry (authoringfw.formats.base.FORMAT_REGISTRY) is the source of truth.

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

Changelog

See CHANGELOG.md.

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.11.5.tar.gz (67.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.11.5-py3-none-any.whl (53.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iil_authoringfw-0.11.5.tar.gz
  • Upload date:
  • Size: 67.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.11.5.tar.gz
Algorithm Hash digest
SHA256 0258b8d7b6e5f22723c18b1044cfb9c66e9bf1e40b30b9845db60305222d2099
MD5 907afab9812e4279e78ab711dc926b68
BLAKE2b-256 ef15c211d9e0e1abdfbee2992f7e6ebe35184f8b773035afc0cd73307274e98b

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_authoringfw-0.11.5.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.11.5-py3-none-any.whl.

File metadata

File hashes

Hashes for iil_authoringfw-0.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 383c49e8cbdf423eca7516fa44bbbde631a09cb1424d9b516facc5bdf72f18c6
MD5 3ab8d1b1b527f81032bcac6f20ff77b8
BLAKE2b-256 c4f9fe0adca7acff559af5913aa1dc2a7df6535d0fad90971f4b5e55f249167d

See more details on using hashes here.

Provenance

The following attestation bundles were made for iil_authoringfw-0.11.5-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