Skip to content

Commit

Permalink
rewrite readme
Browse files Browse the repository at this point in the history
relevant notes are now tracked as github issues
  • Loading branch information
wbolster committed Jul 1, 2017
1 parent f3bd840 commit dc0a109
Showing 1 changed file with 5 additions and 30 deletions.
35 changes: 5 additions & 30 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,17 @@
sanest
======

*sane nested dictionaries and lists*

.. image:: https://travis-ci.org/wbolster/sanest.svg?branch=master
:target: https://travis-ci.org/wbolster/sanest

sane nested dictionaries and lists

*sanest* is a python library that makes it easy to work with nested
dictionaries and lists, such as those commonly used in json formats,
without losing your sanity.

this is a work-in-progress and you should not use it (for now).


todo and ideas
==============

note: this is just a braindump, not a check list. some ideas may not
be good ideas after all and may never make it into this library.

* nested walk helpers dict.walk() and list.walk()

* configurability

* maybe factory helper that produces two custom classes?
* e.g. mydict, mylist = sanest.make_contains(options=would, go=here)
* requires major overhaul

* public api for read-only structures?

* construct-only
* sanest.dict.readonly()
* what about mixing?

* maybe list.contains() with type= arg that checks provided value
while also checking containment
* Documentation: https://sanest.readthedocs.io/

* typed list.__contains__
* Python Package Index (PyPI): https://pypi.python.org/pypi/sanest/

* add a .clean(deep=True) helper (needs better name) to remove None
values from a (nested) dict
* Source code and issue tracker: https://github.com/wbolster/sanest

0 comments on commit dc0a109

Please sign in to comment.