Metadata-Version: 2.1
Name: dumpo
Version: 0.0.1
Summary: Dumpo Python Object Serialiser
Home-page: https://github.com/jackyko8/dumpo
Author: Jacky Ko
Author-email: jko@accsoft.com.au
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/jackyko8/dumpo/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# Dumpo Python Object Serialiser

Dumpo serialises a Python object recursively to arbitrary levels, optionally in a JSON like format.

Synopsis:
```
from dumpo import *
obj_str = dumpo(obj)
```

Keyword arguments:

| Argument          | Description                                                  |                | Default Value |
| ----------------- | ------------------------------------------------------------ | -------------- | ------------- |
| as_is             | List of data types to be shown as is. i.e., `print(f'{obj}')` | List or string | `[]`          |
| as_is_tag         | String to append to a data item serialised "as is"           | String         | `<as_is>`     |
| compressed        | If True compress list to a single line instead of one data item per line | Boolean        | `True`        |
| debug             | If True append debug information to each data item           | Boolean        | `False`       |
| excluded          | List of item names to be excluded from serialisation         | List or string | `[]`          |
| excluded_tag      | String to replace excluded data items. Blank to hide the data item altogether. | String         | `<excluded>`  |
| expand_keys       | If True serialise structured item keys, else show them "as is" | Boolean        | `False`       |
| include_functions | If True include object functions (names only without code)   | Boolean        | `False`       |
| indent            | String for indentation, repeat for each level                | String         | `"| "`        |
| item_quotes       | Quotation marks for item key - 2-character string for open and close respectively; 1-character string if open and close are the same; blank means no quotation marks for item keys | String         | `None`        |
| json_like         | If True serialise in JSON format - implying `indent="  "` and `item_quotes = '"'`, and all `False` for `show_types` and `show_all_types`. | Boolean        | `False`       |
| maxdepth          | Maximum levels to serialised                                 | Integer        | `5`           |
| quotes            | Quotation marks for data item - 2-character string for open and close respectively; 1-character string if open and close are the same; blank means no quotation marks for data items | String         | `""`          |
| show_all_types    | If True prepend data type to data items of all types, e.g., `<type>{ ... }` | Boolean        | `True`        |
| show_types        | If True prepend data type to data items except for simple scalar types, e.g., `<type>{ ... }` | Boolean        | `True`        |
| too_deep_tag      | String to replace data items beyond `maxdepth` levels        | String         | `<too_deep>`  |

[Dumpo at GitHub](https://github.com/jackyko8/dumpo)


