Rooba
/
python-benedict
mirror of https://github.com/fabiocaccamo/python-benedict.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README. [ci skip]

This commit is contained in:
Fabio Caccamo 2020-01-16 18:21:10 +01:00 committed by GitHub
parent b6a09f0153
commit 83047880d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -16,8 +16,14 @@
# python-benedict
python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts (`Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`) and many **utilities**... for humans, obviously.
## Features
- 100% **backward-compatible**, you can safely wrap existing dictionaries.
- Full **keypath** support using **keypath-separator** *(dot syntax by default)* or **list of keys**.
- Easy **I/O operations** with most common formats: `Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`.
- Many **utility** and **parse methods** to retrieve data as needed *(check the [API](#api) section)*.
- Well **tested**, check the badges ;)
## Index
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Basics](#basics)
@ -32,13 +38,6 @@ python-benedict is a dict subclass with **keypath** support, **I/O** shortcuts (
- [Testing](#testing)
- [License](#license)
## Features
- Full **keypath** support using **keypath-separator** *(dot syntax by default)* or **list of keys**.
- Easy **I/O operations** with most common formats: `Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`
- Many **utility** and **parse methods** to retrieve data as needed *(all methods listed below)*
- Well **tested**, check the badges ;)
- 100% **backward-compatible** *(you can replace existing dicts without pain)*
## Installation
- Run `pip install python-benedict`