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, CHANGELOG and version.

This commit is contained in:
Fabio Caccamo 2020-01-30 15:34:37 +01:00
parent 646d00adde
commit a39402c1ec
3 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.16.0](https://github.com/fabiocaccamo/python-benedict/releases/tag/0.16.0) - 2020-01-30
- Added `KeylistDict` with list indexes support. #1
- Added `benedict.utils.type_util` with many utility functions.
- Improved code quality and CI.
## [0.15.0](https://github.com/fabiocaccamo/python-benedict/releases/tag/0.15.0) - 2020-01-13
- Added `rename` method.
- Added `search` method.

12
README.md
View File

@ -13,11 +13,12 @@
[![Requirements Status](https://requires.io/github/fabiocaccamo/python-benedict/requirements.svg?branch=master)](https://requires.io/github/fabiocaccamo/python-benedict/requirements/?branch=master)
# 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.
python-benedict is a dict subclass with **keylist/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**.
- Full **keylist** support using **list of keys** as key.
- Full **keypath** support using **keypath-separator** *(dot syntax by default)*.
- 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 ;)
@ -209,9 +210,10 @@ Utilities that return a dictionary always return a new `benedict` instance.
- #### clean
```python
# Clean the current dict removing all empty values: None, '', {}, [], ().
# If strings, dicts or lists flags are False, related empty values will not be deleted.
d.clean(strings=True, dicts=True, lists=True)
# Clean the current dict instance removing all empty values: None, '', {}, [], ().
# If strings or collections (dict, list, set, tuple) flags are False,
# related empty values will not be deleted.
d.clean(strings=True, collections=True)
```
- #### clone

4
benedict/metadata.py
View File

@ -2,8 +2,8 @@
__author__ = 'Fabio Caccamo'
__copyright__ = 'Copyright (c) 2019 Fabio Caccamo'
__description__ = '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.'
__description__ = 'python-benedict is a dict subclass with keylist/keypath support, I/O shortcuts (Base64, CSV, JSON, TOML, XML, YAML, query-string) and many utilities... for humans, obviously.'
__email__ = 'fabio.caccamo@gmail.com'
__license__ = 'MIT'
__title__ = 'benedict'
__version__ = '0.15.0'
__version__ = '0.16.0'