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 2019-05-20 11:16:43 +02:00
parent a23b86983c
commit 5320ba62c5
2 changed files with 9 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
[![Build Status](https://travis-ci.org/fabiocaccamo/python-benedict.svg?branch=master)](https://travis-ci.org/fabiocaccamo/python-benedict)
[![codecov](https://codecov.io/gh/fabiocaccamo/python-benedict/branch/master/graph/badge.svg)](https://codecov.io/gh/fabiocaccamo/python-benedict)
[![Code Health](https://landscape.io/github/fabiocaccamo/python-benedict/master/landscape.svg?style=flat)](https://landscape.io/github/fabiocaccamo/python-benedict/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0dbd5cc2089f4dce80a0e49e6822be3c)](https://www.codacy.com/app/fabiocaccamo/python-benedict)
[![Requirements Status](https://requires.io/github/fabiocaccamo/python-benedict/requirements.svg?branch=master)](https://requires.io/github/fabiocaccamo/python-benedict/requirements/?branch=master)
[![PyPI version](https://badge.fury.io/py/python-benedict.svg)](https://badge.fury.io/py/python-benedict)
[![PyPI downloads](https://img.shields.io/pypi/dm/python-benedict.svg)](https://img.shields.io/pypi/dm/python-benedict.svg)
@ -26,7 +26,7 @@ python-benedict is the Python dictionary that helps humans dealing with evil dat
## Usage
`benedict` is a dict subclass, so it is possible to use it as a normal dict *(you can just cast an existing dict)*.
#### Basic get/set using keypath:
### Basic get/set using keypath
```python
from benedict import benedict
@ -39,7 +39,7 @@ print(d['profile']) # -> { 'firstname':'Fabio', 'lastname':'Caccamo' }
print('profile.lastname' in d) # -> True
```
#### Utility methods:
### Utility methods
```python
# Get value by key or keypath trying to return it as bool.

20
README.rst
View File

@ -1,4 +1,4 @@
|Build Status| |codecov| |Code Health| |Requirements Status|
|Build Status| |codecov| |Codacy| |Requirements Status|
|PyPI version| |PyPI downloads| |Py versions| |License|
python-benedict
@ -35,8 +35,8 @@ Usage
``benedict`` is a dict subclass, so it is possible to use it as a normal
dict *(you can just cast an existing dict)*.
Basic get/set using keypath:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Basic get/set using keypath
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
@ -49,8 +49,8 @@ Basic get/set using keypath:
print(d['profile']) # -> { 'firstname':'Fabio', 'lastname':'Caccamo' }
print('profile.lastname' in d) # -> True
Utility methods:
^^^^^^^^^^^^^^^^
Utility methods
^^^^^^^^^^^^^^^
.. code:: python
@ -156,18 +156,10 @@ License
Released under `MIT License <LICENSE.txt>`__.
.. |Build Status| image:: https://travis-ci.org/fabiocaccamo/python-benedict.svg?branch=master
:target: https://travis-ci.org/fabiocaccamo/python-benedict
.. |codecov| image:: https://codecov.io/gh/fabiocaccamo/python-benedict/branch/master/graph/badge.svg
:target: https://codecov.io/gh/fabiocaccamo/python-benedict
.. |Code Health| image:: https://landscape.io/github/fabiocaccamo/python-benedict/master/landscape.svg?style=flat
:target: https://landscape.io/github/fabiocaccamo/python-benedict/master
.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/0dbd5cc2089f4dce80a0e49e6822be3c
.. |Requirements Status| image:: https://requires.io/github/fabiocaccamo/python-benedict/requirements.svg?branch=master
:target: https://requires.io/github/fabiocaccamo/python-benedict/requirements/?branch=master
.. |PyPI version| image:: https://badge.fury.io/py/python-benedict.svg
:target: https://badge.fury.io/py/python-benedict
.. |PyPI downloads| image:: https://img.shields.io/pypi/dm/python-benedict.svg
:target: https://img.shields.io/pypi/dm/python-benedict.svg
.. |Py versions| image:: https://img.shields.io/pypi/pyversions/python-benedict.svg
:target: https://img.shields.io/pypi/pyversions/python-benedict.svg
.. |License| image:: https://img.shields.io/pypi/l/python-benedict.svg
:target: https://img.shields.io/pypi/l/python-benedict.svg