Skip to content

Commit a39402c

Browse files
committed
Updated README, CHANGELOG and version.
1 parent 646d00a commit a39402c

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [0.16.0](https://github.com/fabiocaccamo/python-benedict/releases/tag/0.16.0) - 2020-01-30
8+
- Added `KeylistDict` with list indexes support. #1
9+
- Added `benedict.utils.type_util` with many utility functions.
10+
- Improved code quality and CI.
11+
712
## [0.15.0](https://github.com/fabiocaccamo/python-benedict/releases/tag/0.15.0) - 2020-01-13
813
- Added `rename` method.
914
- Added `search` method.

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@
1313
[![Requirements Status](https://requires.io/github/fabiocaccamo/python-benedict/requirements.svg?branch=master)](https://requires.io/github/fabiocaccamo/python-benedict/requirements/?branch=master)
1414

1515
# python-benedict
16-
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.
16+
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.
1717

1818
## Features
1919
- 100% **backward-compatible**, you can safely wrap existing dictionaries.
20-
- Full **keypath** support using **keypath-separator** *(dot syntax by default)* or **list of keys**.
20+
- Full **keylist** support using **list of keys** as key.
21+
- Full **keypath** support using **keypath-separator** *(dot syntax by default)*.
2122
- Easy **I/O operations** with most common formats: `Base64`, `CSV`, `JSON`, `TOML`, `XML`, `YAML`, `query-string`.
2223
- Many **utility** and **parse methods** to retrieve data as needed *(check the [API](#api) section)*.
2324
- Well **tested**, check the badges ;)
@@ -209,9 +210,10 @@ Utilities that return a dictionary always return a new `benedict` instance.
209210
- #### clean
210211

211212
```python
212-
# Clean the current dict removing all empty values: None, '', {}, [], ().
213-
# If strings, dicts or lists flags are False, related empty values will not be deleted.
214-
d.clean(strings=True, dicts=True, lists=True)
213+
# Clean the current dict instance removing all empty values: None, '', {}, [], ().
214+
# If strings or collections (dict, list, set, tuple) flags are False,
215+
# related empty values will not be deleted.
216+
d.clean(strings=True, collections=True)
215217
```
216218

217219
- #### clone

benedict/metadata.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
__author__ = 'Fabio Caccamo'
44
__copyright__ = 'Copyright (c) 2019 Fabio Caccamo'
5-
__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.'
5+
__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.'
66
__email__ = '[email protected]'
77
__license__ = 'MIT'
88
__title__ = 'benedict'
9-
__version__ = '0.15.0'
9+
__version__ = '0.16.0'

0 commit comments

Comments
 (0)