Skip to main content

Python dict formatted dumper.

Project description

# DictDumper

  The `dictdumper` project is an open source Python program works as a stream formatted output dumper for `dict`.

- [About](#about)
* `dictdumper.Dumper`
* `dictdumper.JSON`
* `dictdumper.PLIST`
* `dictdumper.Tree`
* `dictdumper.XML`
* `dictdumper.HTML`
- [Installation](#installation)
- [Usage](#usage)

---

### About

  Currently, it supports following formats --

- `dictdumper.Dumper` -- abstract base class of all dumpers
- `dictdumper.JSON` -- dump JavaScript object notation (`JSON`) format file
- `dictdumper.PLIST` -- dump Apple property list (`PLIST`) format file
- `dictdumper.Tree` -- dump tree-view text (`TXT`) format file
- `dictdumper.XML` -- dump extensible Mmarkup language (`XML`) file (__base class__)
- `dictdumper.HTML` -- dump JavaScript file under `Vue.js` framework (__DEPRECATED__)

![](./doc/dictdumper.png)

 

### Installation:

> Note that `dictdumper` only supports Python versions __since 3.0__

```
pip install dictdumper
```

 

### Usage

  `dictdumper` is quite easy to use. After installation, importation, and initialisation, you can simple call the instance to dump contents.

> Take `dictdumper.Tree` for example

```python
import dictdumper
dumper = dictdumper.Tree('out.txt')
test_1 = dict(
foo = -1, # int
bar = 'Hello, world!', # string
boo = dict( # dict
foo_again = True, # bool
bar_again = b'bytes', # bytes (b'\x62\x79\x74\x65\x73')
boo_again = None, # NoneType
),
)
dumper(test_1, name='test_1')
```
```
$ cat out.txt
PCAP File Tree-View Format

test
|-- foo -> -1
|-- bar -> hello
|-- boo
|-- foo_again -> True
|-- bar_again -> 62 79 74 65 73
|-- boo_again -> N/A
```
```python
import datetime
test_2 = dict(
foo = [1, 2.0, 3], # list
bar = (1.0, 2, 3.0), # tuple
boo = dict( # dict
foo_again = 'a long long bytes',
# bytes
bar_again = datetime.datetime.today(),
# datetime
boo_again = -1.0, # float
),
)
dumper(test_2, name='test_2')
```
```
$ cat out.txt
PCAP File Tree-View Format

test_1
|-- foo -> -1
|-- bar -> Hello, world!
|-- boo
|-- foo_again -> True
|-- bar_again -> 62 79 74 65 73
|-- boo_again -> N/A

test_2
|-- foo
| |--> 1
| |--> 2.0
| |--> 3
|-- bar
| |--> 1.0
| |--> 2
| |--> 3.0
|-- boo
|-- foo_again -> a long long bytes
|-- bar_again -> 2018-03-08 17:47:35
|-- boo_again -> -1.0
```

Release history Release notifications

This version
History Node

0.5.0.post1

History Node

0.5.0

History Node

0.0.1.dev1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dictdumper-0.5.0.post1-py2.py3-none-any.whl (12.8 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jun 29, 2018
dictdumper-0.5.0.post1.tar.gz (62.0 kB) Copy SHA256 hash SHA256 Source None Jun 29, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page