From a39402c1ecd0853dad02c05de792602088c8eec1 Mon Sep 17 00:00:00 2001 From: Fabio Caccamo Date: Thu, 30 Jan 2020 15:34:37 +0100 Subject: [PATCH] Updated README, CHANGELOG and version. --- CHANGELOG.md | 5 +++++ README.md | 12 +++++++----- benedict/metadata.py | 4 ++-- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 55a8005..908c218 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/README.md b/README.md index 403f0da..ffa85fc 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/benedict/metadata.py b/benedict/metadata.py index 7e2b8fb..691ff80 100644 --- a/benedict/metadata.py +++ b/benedict/metadata.py @@ -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'