Metadata-Version: 2.1
Name: dumpit
Version: 0.5.0
Summary: Print python objects like a boss
Home-page: https://github.com/arrrlo/dumpit
Author: Ivan Arar
Author-email: ivan.arar@gmail.com
License: MIT
Project-URL: Source, https://github.com/arrrlo/dumpit
Keywords: print,object
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Requires-Dist: click (~=7.0)
Requires-Dist: termcolor (~=1.1.0)
Requires-Dist: terminaltables (==3.1.0)

# dumpit
## List all python object attributes with descriptions

[![PyPI version](https://badge.fury.io/py/dumpit.svg)](https://badge.fury.io/py/dumpit)
[![Build Status](https://travis-ci.com/arrrlo/dumpit.svg?branch=master)](https://travis-ci.com/arrrlo/dumpit)

![GitHub issues](https://img.shields.io/github/issues/arrrlo/dumpit.svg)
![GitHub closed issues](https://img.shields.io/github/issues-closed/arrrlo/dumpit.svg)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/arrrlo/dumpit.svg)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dumpit.svg)
![GitHub](https://img.shields.io/github/license/arrrlo/dumpit.svg?color=blue)
![GitHub last commit](https://img.shields.io/github/last-commit/arrrlo/dumpit.svg?color=blue)

![Terminal view](docs/images/terminal.png?3)

### Installation
Works with python 3.x

```
pip install dumpit
```

### Usage

```python
from dumpit import pdumpit, fdumpit

my_object = ...

# Print object to standard output
pdumpit(my_object)

#Print object to standard output in vertical view
pdumpit(my_object, view_='vertical') # vertical | table

# Export object to string as text
my_var = fdumpit(my_object)

# Disable colors in terminal output
pdumpit(my_object, colors=False) # False | terminal

# Enable colors in string output
my_var = fdumpit(my_object, colors='terminal')

# Don't show dunder methods (magic methods)
pdumpit(my_object, all_=False)
```

# Changelog

## 0.5.0

#### Fixed
- Python 3 compatibility

## 0.4.2

#### Fixed
- Dependency version changed: Click 6.7 -> Click 7.0

## 0.4.1

#### Fixed
- dunder methods description formatting and new lines.

## 0.4.0

#### Added:
- Descriptions for every objects attribute.
- Separate dunders from other attributes. 

## 0.3.0

#### Added:
- Analyse is now view.
- Table view support: Print object contents in table view in terminal.
- Warnings: Prints warnings in terminal if unknown coloring or view is used.

## 0.2.0

#### Added:
- Coloring support: Terminal colors for object attributes.  


