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.8.0.tar.gz (50.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.8.0-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: iil_authoringfw-0.8.0.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for iil_authoringfw-0.8.0.tar.gz
Algorithm Hash digest
SHA256 8782b8be92dc8e2927147557d73feee1e57c52b722b611fc85e1c1971fc95fa8
MD5 512b7cd8f7ba0b22b93ac879e84523dc
BLAKE2b-256 f214161d19154fbf9e376a3775d4a4c27de52d61bcc0aba0f6c61d3197be25fc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for iil_authoringfw-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 77a5afc664b8c751982821d1b6d81963760cfb524c4e4bd9757b8011be0fe119
MD5 7427c86d2f779e7b328b1eb24e82f8ca
BLAKE2b-256 1e188946d36be3e23934e85560af441d367a6e6ca7cbfb5a12c7bcd06cb044ec

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