Metadata-Version: 2.1
Name: dovpanda
Version: 0.0.1a2
Summary: Directions overlay for working with pandas in an analysis environment
Home-page: https://github.com/dovpanda-dev/dovpanda
Author: Dean Langsam
Author-email: deanla@gmail.com
License: UNKNOWN
Description: # dovpanda
        [![Build Status](https://travis-ci.org/dovpanda-dev/dovpanda.svg?branch=master)](https://travis-ci.org/dovpanda-dev/dovpanda)
        [![Documentation Status](https://readthedocs.org/projects/dovpanda/badge/?version=latest)](https://dovpanda.readthedocs.io/en/latest/?badge=latest)
        
        ## Directions OVer PANDAs
        
        Directions overlay for working with pandas in an analysis environment.    
        If you think your task is common enough, it probably is, and Pandas probably has a built-in solution.
        dovpanda is an overlay module that tries to understand what you are trying to do with your data, and help you
        find easier ways to write your code.
        
        ## Usage
        The basic usage of `dovpanda` is very east. you just import it after you import pandas
        ```python
        import pandas as pd
        import dovpanda
        ```     
        This is it. From now on you can expect `dovpanda` to come with helpful directions while
        you are writing you code.
        
        ### Example
        ```python
        In [3]: df = pd.DataFrame({'a':list('xxyy'),'b':[40,50,60,70], 'time':['18:02','18:45','20:12','21:50']})
           ...: df['time'] = pd.to_datetime(df.time)
           ...: df['hour'] = df.time.dt.hour
        
        In [4]: df.groupby('hour').b.sum()
        ===== Seems like you are grouping by a column named 'hour', consider setting the your
        time column as index and then use df.resample('h') =====
        Out[4]:
        hour
        18    90
        20    60
        21    70
        Name: b, dtype: int64
        ```
        
        ### Notebook Support
        Running `dovpanda` in a notebook environment will display rendered dismissable html.
        <img width="800" alt="notebook display" src="https://user-images.githubusercontent.com/7852981/67240707-aee52e80-f45a-11e9-9f6b-8dca0b9af3d5.png">
        
        ## Advanced Usage
        ### Random Tips
        `dovpanda.tip()` will give you a random `pandas` tip.
        
        ### Change Display
        use `dovpanda.set_output` if you want to change output.
        
        ```python
        In [14]: dovpanda.set_output('display')
        
        In [15]: df.iterrows()
        ===== iterrows is not recommended, and in the majority of cases will have better alternatives =====
        Out[15]: <generator object DataFrame.iterrows at 0x110fe4318>
        
        In [16]: dovpanda.set_output('print')
        
        In [17]: df.iterrows()
        iterrows is not recommended, and in the majority of cases will have better alternatives
        Out[17]: <generator object DataFrame.iterrows at 0x112c408b8>
        
        In [18]: dovpanda.set_output('warning')
        
        In [19]: df.iterrows()
        WARNING:dovpanda:iterrows is not recommended, and in the majority of cases will have better alternatives
        Out[19]: <generator object DataFrame.iterrows at 0x110ee7e58>
        
        In [20]: dovpanda.set_output('off')
        
        In [21]: df.iterrows()
        Out[21]: <generator object DataFrame.iterrows at 0x1047c4d68>```
         
        
        
        
        Documentation
        -------------
        
        The full documentation is at http://dovpanda.rtfd.org.
        
        
        
        History
        -------
        
        0.0.2 (2019-10-30)
        ++++++++++++++++++
        
        * First release on PyPI.
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.6
Description-Content-Type: text/markdown
