A Python package for validating chatfic-format data
Project description
Chatfic Validator
Description
The Chatfic Validator is a Python package for validating chatfic data. It checks the format and structure of chatfic data to ensure it conforms to the specified schema.
Installation
To install the Chatfic Validator, you can use pip:
pip install chatfic-validator
Usage
Here's an example of how to use the Chatfic Validator:
from chatfic_validator import ChatficValidator as validator
# Load the chatfic data from a file
with open('storybasic.json', 'r', encoding="utf-8") as file:
json_text = file.read()
# Validate the chatfic data
result = validator.validate_json_text(
json_text=json_text,
chatfic_format=ChatficFormat.BASIC_JSON,
multimedia_list=["time.jpeg"]
)
# Check if the validation was successful
if result.is_valid:
print("Chatfic data is valid!")
else:
print("Chatfic data is invalid.")
for error in result.errors:
print(error)
for warning in result.warnings:
print(warning)
ChatficFormat
enums: BASIC_JSON and COMPILED_JSON. These represent the storybasic.json and story.json file contents, respectively.
The multimedia_list
parameter takes a list of the multimedia files that are expected to referenced within the story data.
validate_json_text
method returns a ChatficValidationResult
instance with 3 attributes:
is_valid:bool
errors: List[ChatficValidationError]
warnings: List[str]
validate_json_text
method loads json text and runs validate_dict
method. This second method can be used directly with the same parameters (chatfic_format and multimedia_list)
More information about the chatfic-format can be found here:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for chatfic_validator-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8d04f1719f90bae1dd10f037697be318785e615452c93ff6e9bd096358297c0 |
|
MD5 | 74e84f51206a86a915e368a76498583e |
|
BLAKE2b-256 | 586413b1598528cb6bda1e882fc21aa59985a4a482c90162d3a635649c4e3fb8 |