Metadata-Version: 2.1
Name: featherhelper
Version: 0.0.5
Summary: Feather Helper is a concise interface to cache numpy arrays and pandas dataframes.
Home-page: https://github.com/kiwi0fruit/featherhelper
Author: Peter Zagubisalo
Author-email: peter.zagubisalo@gmail.com
License: MIT
Description: # Feather Helper
        
        Feather Helper is a concise interface to cache and load numpy arrays and pandas dataframes. I use it with  [Pandoctools/Knitty](https://github.com/kiwi0fruit/pandoctools).
        
        
        # Contents
        
        * [Feather Helper](#feather-helper)
        * [Contents](#contents)
        * [Install](#install)
        * [Usage example](#usage-example)
        
        
        # Install
        
        Via conda:
        
        ```
        conda install -c defaults -c conda-forge featherhelper
        ```
        
        Via pip:
        
        ```
        pip install featherhelper
        ```
        
        
        ## Usage example
        
        ```py
        import pandas as pd
        import numpy as np
        import featherhelper as fh
        fh.setdir("~/feather/mydoc")  # (optional)
        # fh.exc(1, 2)  # force raise exceptions for names (optional)
        
        # %%
        fh.name(1)  # can also be fh.name('id1'), default is 'default', 1 is the same as '1'
        try:
            # raise fh.Err  # (optional)
            df, A, B = fh.pull()  # control length can be set: fh.pull(N)
        except fh.Err:
            # calculate:
            print('push')  
            df = pd.DataFrame(np.random.random(16).reshape(4, 4))
            A = df.values
            B = np.random.random(16 * 3).reshape(4, 2, 2, 3)
            #
            fh.push(df, A, B)
        
        print(df, '\n', A, '\n', B)
        ```
        
        A shorter example:
        ```py
        import numpy as np
        import featherhelper as fh
        # fh.exc()
        
        # %%
        try:
            A = fh.pull()
        except fh.Err:
            A = np.random.random(16).reshape(4, 4)
            fh.push(A)
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/markdown
