Metadata-Version: 2.1
Name: bff
Version: 0.1.2
Summary: Best Fancy Functions, your Best Friend Forever
Home-page: https://github.com/axelfahy/FancyThings/tree/master/bff
Author: Axel Fahy
Author-email: axel@fahy.net
License: MIT
Description: # BFF
        > Best Fancy Functions, your Best Friend Forever
        
        <p align="left">
            <a href="https://pypi.org/project/bff/">
                <img src="https://img.shields.io/pypi/v/bff.svg" alt="latest release" /></a>
            <a href="https://pypi.org/project/bff/">
                <img src="https://img.shields.io/badge/python-3.6-blue.svg" alt="Python36" /></a>
        </p>
        
        This package contains some utility functions from plots to data manipulations and could become your new bff.
        
        ## Installation
        
        ```sh
        pip install bff
        ```
        
        ## Usage example
        
        Examples are available in the docstrings of the functions. Official documentation will soon come out.
        
        ## Development setup
        
        Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
        
        ```sh
        git clone https://github.com/axelfahy/FancyThings.git
        cd FancyThings/bff
        python -m venv venv-dev
        source venv-dev/bin/activate
        pip install -e .
        ```
        
        ## Tests
        
        ```sh
        python tests/test_fancy.py
        ```
        
        ## Release History
        
        * 0.1.2
            * CHANGE: Add axes in plot functions
            * ADD: Function `plot_predictions` function to plot the actual values and the predictions of a model
        * 0.1.1
            * CHANGE: Improvement of `plot_history` function
            * ADD: Readme with instructions
            * FIX: Fix the imports in the test
        * 0.1.0
            * Initial release
        
        ## Meta
        
        Axel Fahy – axel@fahy.net
        
        Distributed under the MIT license. See ``LICENSE`` for more information.
        
        [https://github.com/axelfahy](https://github.com/axelfahy)
        
        ## Contributing
        
        1. Fork it (<https://github.com/yourname/yourproject/fork>)
        2. Create your feature branch (`git checkout -b feature/fooBar`)
        3. Commit your changes (`git commit -am 'Add some fooBar'`)
        4. Push to the branch (`git push origin feature/fooBar`)
        5. Create a new Pull Request
        
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
