Metadata-Version: 2.1
Name: pdir2
Version: 0.3.2
Summary: Pretty dir printing with joy
Home-page: http://github.com/laike9m/pdir2
Author: laike9m
Author-email: laike9m@gmail.com
License: MIT License
Description: :warning: On master branch, pdir2's codebase is **Python 3.5+**, with annotations and mypy check. The Python 2 compatible version exists in the [0.3.x](https://github.com/laike9m/pdir2/tree/0.3.x) branch and will still be receiving bug fixes. All new features will be developed on master therefore is Python 3.5+ exclusive.
        
        In short, if you're still using pdir2 for Python &lt;3.5, install via `pip install "pdir2>=0.3,<0.4"`.
        
        # pdir2: Pretty dir() printing with joy
        
        [![Build Status](https://travis-ci.org/laike9m/pdir2.svg)](https://travis-ci.org/laike9m/pdir2)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/pdir2.svg)](https://pypi.python.org/pypi/pdir2/)
        ![PyPI Version](https://img.shields.io/pypi/v/pdir2.svg)
        <a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
        
        Have you ever dreamed of a better output of `dir()`? I do. So I created this.
        
        ![](https://github.com/laike9m/pdir2/raw/master/images/presentation_v2.gif)
        
        ## Features
        
        -   Attributes are grouped by types/functionalities, with beautiful colors.
        
        -   Support color customization, [here's how](https://github.com/laike9m/pdir2/wiki/User-Configuration).
        
        -   Support all platforms including Windows(Thanks to [colorama](https://github.com/tartley/colorama)).
        
        -   Support [ipython](https://github.com/ipython/ipython), [ptpython](https://github.com/jonathanslenders/ptpython), [bpython](https://www.bpython-interpreter.org/) and [Jupyter Notebook](http://jupyter.org/)! See [wiki](https://github.com/laike9m/pdir2/wiki/REPL-Support) for details.
        
        -   The return value of `pdir()` can still be used as a list of names.
        
        -   ✨ Attribute searching
        
            You can search for certain names with `.s()` or `.search()`:  
        
            ![](https://github.com/laike9m/pdir2/raw/master/images/search.gif)
        
            Search is case-insensitive by default.  
             `search(name, case_sensitive=True)` does case sensitive searching.
        
        -   :star2: Attribute filtering
        
            `properties`: Find properties/variables defined in the inspected object.
        
            `methods`: Find methods/functions defined in the inspected object.
        
            `public`: Find public attributes.
        
            `own`: Find attributes that are not inherited from parent classes.
        
            These filters **can be chained!** Order does **NOT** matter.
        
            For example, use `pdir(obj).public.own.methods` to find all public own methods.
        
            You can also call `search` on the returned results.
        
            See a [complete example](https://github.com/laike9m/pdir2/wiki/Attribute-Filtering).
        
        ## Install
        
        ### Generic
        
            pip install pdir2
        
        About the name. I wanted to call it "pdir", but there's already one with this
        name on pypi. Mine is better, of course.
        
        ### Fedora
        
            dnf install python3-pdir2
            --or--
            dnf install python2-pdir2
        
        ## Automatic Import
        
        As a better alternative of `dir()`, it's more convenient to automatically import
        pdir2 when launching REPL. Luckily, Python provides a way to do this. In you `.bashrc`(or `.zshrc`), add this line:
        
            export PYTHONSTARTUP=$HOME/.pythonstartup
        
        Then, create `.pythonstartup` in your home folder. Add one line:
        
            import pdir
        
        Next time you launch REPL, `pdir()` is already there, Hooray!
        
        ## Testing
        
        Simply run `pytest`, or use `tox` if you like.
        
        ## Developement
        
        Clone the source, run `make install_dev_packages`.   
        Don't forget to add proper type annotations,
        if you're not sure what to do, check out the `gen_type_info` section in `tox.ini`.
        
        
        Release History
        ===============
        
        0.3.1(2018-10-25)
        -----------------
        * Add support for `__slots__` (#44, #45)
        * Seperate `@staticmethod` with other descriptors(#38, #42)
        * Add `__post_init__` support
        
        Special thanks to @liwt31 for his great contribution.
        
        0.3.0(2018-02-10)
        -----------------
        * Add support for various filters (#37)
        
        0.2.0(2017-04-04)
        -----------------
        * Add support for color customization. (#14)
        
        0.1.0(2017-03-16)
        ------------------
        * Add support for ipython, ptpython and bpython (#4)
        
        0.0.2(2017-03-11)
        ---------
        
        ### API Changes (Backward-Compatible)
        
        * Added a `case_sensitive` parameter into the `search` function (#5)
        
        ### Bugfixes
        * Error calling pdir(pandas.DataFrame) (#1)
        * Methods are now considered functions (#6)
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: CPython
Description-Content-Type: text/markdown
