Skip to main content

human readable and writable data interchange format

Project description

https://pepy.tech/badge/nestedtext/month https://img.shields.io/readthedocs/nestedtext.svg https://github.com/KenKundert/nestedtext/actions/workflows/build.yaml/badge.svg https://coveralls.io/repos/github/KenKundert/nestedtext/badge.svg?branch=master https://img.shields.io/pypi/v/nestedtext.svg https://img.shields.io/pypi/pyversions/nestedtext.svg
Authors: Ken & Kale Kundert
Version: 3.3.0
Released: 2022-06-07
Documentation: nestedtext.org.
Please post all questions, suggestions, and bug reports to: Github.

NestedText is a file format for holding structured data to be entered, edited, or viewed by people. It organizes the data into a nested collection of dictionaries, lists, and strings without the need for quoting or escaping. A unique feature of this file format is that it only supports one scalar type: strings.  While the decision to eschew integer, real, date, etc. types may seem counter intuitive, it leads to simpler data files and applications that are more robust.

NestedText is convenient for configuration files, address books, account information, and the like. Because there is no need for quoting or escaping, it is particularly nice for holding code fragments. Here is an example of a file that contains a few addresses:

# Contact information for our officers

Katheryn McDaniel:
    position: president
    address:
        > 138 Almond Street
        > Topeka, Kansas 20697
    phone:
        cell: 1-210-555-5297
        home: 1-210-555-8470
            # Katheryn prefers that we always call her on her cell phone.
    email: KateMcD@aol.com
    additional roles:
        - board member

Margaret Hodge:
    position: vice president
    address:
        > 2586 Marigold Lane
        > Topeka, Kansas 20682
    phone: 1-470-555-0398
    email: margaret.hodge@ku.edu
    additional roles:
        - new membership task force
        - accounting task force

Contributing

This package contains a Python reference implementation of NestedText and a test suite. Implementation in many languages is required for NestedText to catch on widely. If you like the format, please consider contributing additional implementations.

Also, please consider using NestedText for any applications you create. It is especially suitable for configuration files.

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

nestedtext-3.3.0.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

nestedtext-3.3.0-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

Details for the file nestedtext-3.3.0.tar.gz.

File metadata

  • Download URL: nestedtext-3.3.0.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for nestedtext-3.3.0.tar.gz
Algorithm Hash digest
SHA256 f11b27b4587c35e44608fdbf0566f779be35c243cd2bf9646a9e84947eb21069
MD5 4c4ea7ece05a29522ed0207585d0bf94
BLAKE2b-256 42343a5c91aa352d18be5bd46e58810378ffa0d24d4189083df3c0c2044d4935

See more details on using hashes here.

File details

Details for the file nestedtext-3.3.0-py3-none-any.whl.

File metadata

  • Download URL: nestedtext-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 22.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for nestedtext-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c97fe56580d6c90fde145f8713f531e17c5e5edb821fce664800c4f132acc5b
MD5 d5ed07cf3a161dba62bdf3ea974d4eb4
BLAKE2b-256 faa4df9da4c7d21c0b1a425a05ce5c51b179127bfe61100289f7af0cc7fab824

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page