AutoDict 0.1.0

Dictionary that automatically adds children dictionaries as necessary

AutoDict

Dictionary that automatically adds children dictionaries as necessary. Including a json based serialization and deserialization.

---

Environment

List of dependencies for package to run.

Required

• None

Optional

• None

---

Installation / Build / Deployment

Install module

> python -m pip install .

For development, install as a link to repository such that code changes are used.

> python -m pip install -e .

---

Usage

import autodict import AutoDict, JSONAutoDict

d = AutoDict()
d["level0"]["level1"]["level2"]["level3"]["level4"] = "value"
print(d)
## TODO

with JSONAutoDict("autodict.json") as j:
  j["level0"]["level1"]["level2"]["level3"]["level4"] = "value"

with open("autodict.json") as f:
  print(f.read())
  ## TODO

with JSONAutoDict("autodict.json") as j:
  j["level0"]["key"] = "another value"

with open("autodict.json") as f:
  print(f.read())
  ## TODO

---

Running Tests

To run the automated tests, execute unittest discover:

> python -m unittest discover tests -v

To run the automated tests with coverage, execute coverage run:

> python -m coverage run
> python -m coverage report

---

Development

Code development of this project adheres to Google Python Guide

Styling

Use yapf to format files, based on Google's guide with the exception of indents being 2 spaces.

---

Versioning

Versioning of this projects adheres to Semantic Versioning and is implemented using git tags.