python-kanka 2.4.0

Python client for the Kanka API

python-kanka

A modern Python client for the Kanka API, the collaborative worldbuilding and campaign management platform.

Originally inspired by/forked from Kathrin Weihe's python-kanka. Thank you to Kathrin for the foundation and inspiration.

Features

• 12 Entity Types: Characters, Locations, Organisations, Families, Calendars, Events, Quests, Journals, Notes, Tags, Races, Creatures
• Type Safety: Built with Pydantic v2 for data validation and type hints
• Consistent API: Same CRUD interface across all entity types
• Posts, Assets & Images: Full support for entity sub-resources and automatic image management
• Search & Filtering: Search across types, filter by name/tags/privacy/dates
• Rate Limit Handling: Automatic retry with exponential backoff
• Pagination: Built-in pagination support with metadata

Installation

pip install python-kanka

Quick Start

from kanka import KankaClient

client = KankaClient(token="your-api-token", campaign_id=12345)

# Create a character
gandalf = client.characters.create(
    name="Gandalf the Grey",
    type="Wizard",
    title="Istari",
)

# List with filters
wizards = client.characters.list(type="Wizard", is_private=False)

# Search across all entity types
results = client.search("dragon")

# Update and delete
gandalf = client.characters.update(gandalf, title="The White")
client.characters.delete(gandalf)

Documentation

See the full documentation for guides, examples, and complete API reference.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Links

• Kanka.io - The Kanka platform
• Kanka API Documentation - Official API docs
• GitHub Repository - Source code
• Issue Tracker - Report bugs or request features