Installation | Documentation

bff

Best Fancy Functions, your Best Friend Forever

This package contains some utility functions from plots to data manipulations and could become your new bff.

Installation

pip install bff

Documentation

Available here.

Development setup

git clone https://github.com/axelfahy/bff.git
cd bff
python -m venv venv-dev
source venv-dev/bin/activate
pip install -r requirements_dev.txt
pip install -e .

Tests

make all

To test plots, images with baseline should be placed in tests/baseline and can be generated using make build-baseline.

As of v0.2, plots are not yet tested in the travis build.

Release History

• 0.2.3
  • ADD: Function normalization_pd to normalize a DataFrame.
• 0.2.2
  • FIX: Function value_2_list renamed to kwargs_2_list.
  • ADD: Function value_2_list to cast a single value.
• 0.2.1
  • ADD: Function plot_counter to plot counter as bar plot.
• 0.2.0
  • ADD: Separation of plots in submodule plot. This breaks the previous API.
  • ADD: Tests for the plot module using pytest-mlp.
  • ADD: Images from plot in the documentation and notebook with examples.
  • FIX: Correction of resampling in the plot_series function.
• 0.1.9
  • ADD: Option loc in plot_series function.
  • ADD: Function cast_to_category_pd to cast columns to category dtype automatically.
• 0.1.8
  • ADD: Option with_missing_datetimes in plot_series function.
  • ADD: Mypy for type verification.
  • FIX: Tests when raising exceptions in sliding_window function.
• 0.1.7
  • ADD: FancyConfig to handle configuration files.
• 0.1.6
  • FIX: Correction of dependencies for doc.
• 0.1.5
  • ADD: Documentation of project on Read the Docs.
• 0.1.4
  • ADD: Function mem_usage_pd to calculate the memory usage of a pandas object.
  • ADD: Function idict to invert the key / values of a dictionary.
  • ADD: Add Makefile for testing code and style.
  • ADD: Add python-versioneer to handle version of package.
• 0.1.3
  • ADD: Travis, flake8, coveralls and PyUp configurations.
  • ADD: Function get_peaks to get the peaks of a time series.
  • ADD: Function plot_series to plot a time series.
  • CHANGE: Restructuration of repo.
• 0.1.2
  • ADD: Function plot_predictions function to plot the actual values and the predictions of a model.
  • CHANGE: Add axes in plot functions.
• 0.1.1
  • ADD: Readme with instructions.
  • CHANGE: Improvement of plot_history function.
  • 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

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

Version number

The version of the package is link to the tag pushed.

To set a new version:

git tag v0.1.4
git push --tags