Skip to main content

A parser and serializer for WSON (Web Simple Object Notation)

Project description

WSON (Web Simple Object Notation)

WSON is a simple, readable data interchange format that combines the best features of JSON and YAML while addressing some of their limitations.

Features

  • Simple and intuitive syntax
  • Supports comments (both // and # styles)
  • Preserves the original formatting when possible
  • Easy to read and write for humans
  • Supports nested objects and arrays
  • Handles strings, numbers, booleans, and null values

Installation

You can install WSON using pip:

pip install wson

Usage

Here's a quick example of how to use WSON in your Python projects:

import wson

# Parse WSON string
wson_data = """
{
    status = "success",
    code = 200,
    message = "Data retrieved successfully",

    user = {
        id = 123,
        name = "John Doe",
        email = "john@example.com",
        age = 25
    },

    tasks = [
        {
            task_id = 1,
            title = "Complete project report",
            status = "in-progress",
            due_date = "2024-10-15"
        },
        {
            task_id = 2,
            title = "Review team feedback",
            status = "pending",
            due_date = "2024-10-20"
        }
    ]
}
"""

# Parse WSON to Python dictionary
parsed_data = wson.parse_wson(wson_data)
print(parsed_data)

# Serialize Python dictionary to WSON
wson_output = wson.serialize_wson(parsed_data)
print(wson_output)

Why WSON?

WSON addresses some limitations of JSON and YAML:

  1. Unlike JSON, WSON supports comments, making it more readable and self-documenting.
  2. WSON has a simpler syntax compared to YAML, reducing the chance of indentation errors.
  3. WSON preserves the original formatting when possible, unlike JSON which often alters the structure.
  4. WSON is more concise than JSON, omitting unnecessary quotation marks for keys.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.

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

wson-0.1.2.tar.gz (2.2 kB view details)

Uploaded Source

Built Distribution

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

wson-0.1.2-py3-none-any.whl (2.1 kB view details)

Uploaded Python 3

File details

Details for the file wson-0.1.2.tar.gz.

File metadata

  • Download URL: wson-0.1.2.tar.gz
  • Upload date:
  • Size: 2.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for wson-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6f920c98d45cbf541fb90d44a7745f051ba80ae7332c638b053a5e3c5c358f89
MD5 9cde1937f5515fad0bf1df58c522c562
BLAKE2b-256 b527e2514da7927ec9122e5b700cf016e3ff2d40e4214e3a63fc59855ba049db

See more details on using hashes here.

File details

Details for the file wson-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: wson-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 2.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.2

File hashes

Hashes for wson-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f9cc1a509b00a12f82ebbc7049758bb56e030d4db7375d5b199f6b9b95f9b80
MD5 dd2d5911e1d632c9a93c133697497ef7
BLAKE2b-256 9d7f8f7f34f386f26da967ff6e7c2c3ed82f36cd7226c546da434b5eb18aa6c0

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