https://github.com/avakar/pytoml

A TOML-0.4.0 parser/writer for Python.
https://github.com/avakar/pytoml

Last synced: 2 days ago
JSON representation

A TOML-0.4.0 parser/writer for Python.

• Host: GitHub
• URL: https://github.com/avakar/pytoml
• Owner: avakar
• License: other
• Created: 2015-03-14T01:17:13.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2019-07-21T17:54:54.000Z (over 5 years ago)
• Last Synced: 2024-11-01T20:12:15.707Z (6 days ago)
• Language: Python
• Homepage:
• Size: 79.1 KB
• Stars: 129
• Watchers: 7
• Forks: 28
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PyPI](https://img.shields.io/pypi/v/pytoml.svg)](https://pypi.python.org/pypi/pytoml)

[![Build Status](https://travis-ci.org/avakar/pytoml.svg?branch=master)](https://travis-ci.org/avakar/pytoml)

# Deprecated

The pytoml project is no longer being actively maintained. Consider using the

[toml](https://github.com/uiri/toml) package instead.

# pytoml

This project aims at being a specs-conforming and strict parser and writer for [TOML][1] files.

The library currently supports [version 0.4.0][2] of the specs and runs with Python 2.7+ and 3.5+.

Install:

    pip install pytoml

The interface is the same as for the standard `json` package.

    >>> import pytoml as toml

    >>> toml.loads('a = 1')

    {'a': 1}

    >>> with open('file.toml', 'rb') as fin:

    ...     obj = toml.load(fin)

    >>> obj

    {'a': 1}

The `loads` function accepts either a bytes object

(that gets decoded as UTF-8 with no BOM allowed),

or a unicode object.

Use `dump` or `dumps` to serialize a dict into TOML.

    >>> print toml.dumps(obj)

    a = 1

## tests

To run the tests update the `toml-test` submodule:

    git submodule update --init --recursive

Then run the tests:

    python test/test.py

  [1]: https://github.com/toml-lang/toml

  [2]: https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.4.0.md