commit | 610750335fff18ca794931ba4093d16ef1b51cb3 | [log] [tgz] |
---|---|---|
author | Josh Austin <josh.austin@gmail.com> | Mon Oct 05 12:52:52 2015 -0400 |
committer | Josh Austin <josh.austin@gmail.com> | Mon Oct 05 12:52:52 2015 -0400 |
tree | 4840b262b19877b456037c7516cf90024ab1a467 | |
parent | 4e15474b5f1c97592a0f6fb53d5ebbe5c561373b [diff] |
update readme
This project aims at being a specs-conforming and strict parser and writer for TOML files. The library currently supports version 0.4.0 of the specs and runs with Python 2.7 and 3.4+.
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
To run the tests update the toml-test
submodule:
$ git submodule update --init --recursive
Then run the tests:
$ python test/test.py