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.2.0.tar.gz (10.4 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.2.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for notedf-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e0f98df05278fb41047f836a2343096d39a941694c5d7826160ea82e2a68ccde
MD5 08a0ae15830a3f9010758537c4b3e54c
BLAKE2b-256 65465842c3b8226c3fc166758655e082a0b86c006b454a027c1130b7d3bc82c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: notedf-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc5934967cc9fdffff18245716d42e1dafe5f1395dfd187428fec31903c777e1
MD5 c9d3614044409daab717155fab01cd9a
BLAKE2b-256 4b0a3b6a259acb250f150731f255d8a2d9d525e96632313cc37abb7b661fe7b4

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