Skip to main content

Note Data Format - Simple, compact, model-optimized data format

Project description

NDF - Note Data Format

Write data like notes, parse like lightning. A simple, compact, model-optimized data format.

Features

  • 40-70% smaller than JSON
  • Write like taking notes - minimal syntax
  • Optimized for AI/ML - token efficient
  • Fast parsing - single-pass parser
  • Bidirectional - parse and serialize

Installation

pip install notedf

Quick Start

from notedf import NoteDataFormat

parser = NoteDataFormat()

# Parse NDF
data = parser.parse("""
user:
  name: Alice
  age: 30
  tags: python ai ml
""")

# Serialize to NDF
ndf_text = parser.dumps(data)

Syntax Examples

Simple Values

name: John Doe age: 30 active: yes score: 95.5

Lists

tags: python ai machine-learning colors: red, blue, green

Nested Objects

user: name: Alice settings: theme: dark notifications: yes

Multi-line Text

description: | This is a multi-line description. It preserves line breaks.

Why NDF?

Feature JSON YAML TOML NDF
Write Speed ⭐⭐ ⭐⭐⭐ ⭐⭐⭐ ⭐⭐⭐⭐⭐
Parse Speed ⭐⭐⭐⭐ ⭐⭐ ⭐⭐⭐ ⭐⭐⭐⭐⭐
Size ⭐⭐ ⭐⭐⭐ ⭐⭐⭐ ⭐⭐⭐⭐⭐
Token Efficiency ⭐⭐ ⭐⭐⭐ ⭐⭐⭐ ⭐⭐⭐⭐⭐

Documentation

Full documentation available at GitHub

License

MIT License - see LICENSE file for details.

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

notedf-0.1.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

notedf-0.1.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file notedf-0.1.0.tar.gz.

File metadata

  • Download URL: notedf-0.1.0.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for notedf-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2ab15de73ad160cad8aa3d6d91beb400b956f15c3248467bd86bda15f3040293
MD5 889016e9a2476406b1bc853c3b836c91
BLAKE2b-256 a7a75eb0317304ce60e6bfd907ae96669400214399d6ecf54ba7da8ba2837bbe

See more details on using hashes here.

File details

Details for the file notedf-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: notedf-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for notedf-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 637cc9273bb42792c18c37465bea3cb8cedfa3e1dd85e354f8d577e25155cfce
MD5 487408796712e6006bc94046cf23e6b4
BLAKE2b-256 df756edd1a673c7222eeb98a9d56fd08e68c93e9a8da5c7e7b8f2ca3082a8742

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