Metadata-Version: 2.1
Name: vistutils
Version: 0.0.1
Summary: vistutils provides helpful utility functions
Home-page: https://github.com/AsgerJon/vistutils
Author: Asger Jon Vistisen
Author-email: Asger Jon Vistisen <asgerjon2@gmail.com>
Project-URL: Homepage, https://github.com/AsgerJon/vistutils
Project-URL: Bug Tracker, https://github.com/AsgerJon/vistutils
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: icecream >=2.1.2

# vistutils

vistutils is a collection of modules providing helpful utility functions. The latest release includes the following functions:

## Installation
You can find the latest version on pypi: https://pypi.org/project/vistutils/
To install, simply run:
~~~
pip install vistutils
~~~

## waila - what am I looking at?

Instead of writing something like:
~~~
for item in dir(obj):
  print(item)
~~~
Simply use waila(obj)! This prints the name of each entry like above including the documentation associated with the object. 
waila supports the following keyword arguments

### print
Prints the contents found (default True)

### dunder
Includes dunder methods of the objects (default False)

### magic 
alias for dunder (default False)

### getReturn
if True, waila(obj) returns items as a list of dictionaries with keys: 'name', 'type' and 'help' (default False)

### fid 
saves the results to a text file of this name.

### save
if True, saves results to textfile, ignored if fid is given, otherwise a filename is generated, which includes the name of the object and the time of save. (default False)
