https://github.com/vshymanskyy/muon

µON - a compact and simple binary object notation
https://github.com/vshymanskyy/muon

binary-format cbor json msgpack

Last synced: 2 months ago
JSON representation

µON - a compact and simple binary object notation

• Host: GitHub
• URL: https://github.com/vshymanskyy/muon
• Owner: vshymanskyy
• License: apache-2.0
• Created: 2015-02-28T12:26:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-29T01:02:51.000Z (almost 2 years ago)
• Last Synced: 2024-04-24T13:15:46.145Z (5 months ago)
• Topics: binary-format, cbor, json, msgpack
• Language: Python
• Homepage:
• Size: 1.9 MB
• Stars: 242
• Watchers: 16
• Forks: 5
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# µON [muon]

A compact and **simple** object notation. µ[mju:] stands for "micro".

[![Muon on Twitter](https://img.shields.io/static/v1?label=%C2%B5ON&message=on%20twitter&color=00acee&logo=twitter)](https://twitter.com/search?q=%C2%B5ON%20muon&f=live)

```log

File extension:     .mu

MIME type:          application/muon

Endianness:         little-endian

Signature/Magic:    optional, 8F B5 30 31 ["�µ01"] @ 0x0

```

Muon has some interesting  properties (see [**presentation**](https://bit.ly/muon-present) and [**docs**](./docs/README.md)):

- Every null-terminated `UTF8` string is at the same time a valid `muon` object

- Gaps in the `UTF8` encoding space (**`code units`**) are used to encode things like `[` `]` `{` `}` etc.

- Muon is **self-describing and schemaless**, just like `JSON` (unlike `Protobuf` and `FlatBuffers`)

- **Compact** (~10..50% smaller than `JSON`). On par or outperforms `CBOR`, `MsgPack`, `UBJSON`

- **Unlimited** size of objects and values

- Data is ready to be used **in-place** without pre-processing

- Supports **raw binary** data (values and `TypedArrays`)

- Can _optionally_ contain count of elements (and size in bytes) of all structures for efficient document processing, similar to `BSON`

Future goals:

- Strict specification (little or no room for implementation-specific behavior / vendor-specific extensions)

## Try it yourself

```sh

python3 muon_py/json2mu.py ./data/AirlineDelays.min.json ./AirlineDelays.mu

python3 muon_py/mu2json.py ./AirlineDelays.mu > ./AirlineDelays.json

```

Run benchmarks:

```sh

python3 muon_py/extra/json-analyze.py ./data/*.json ./data/small/*.json

python3 muon_py/mu-benchmark.py ./data/*.json ./data/small/*.json

```

## Muon structure

[![Muon diagram](docs/muon.png?raw=true)](https://bit.ly/muon-present)

See more [**in documentation**](./docs/README.md).

**Disclaimer: the notation is still Work In Progress.**

If you have any ideas or comments, please feel free to [post them here](https://github.com/vshymanskyy/muon/issues).

---

[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)