Skip to main content

Best Fancy Functions, your Best Friend Forever

Project description

Installation | Documentation

bff

Best Fancy Functions, your Best Friend Forever

Latest Release Build Status Coverage Status Python37

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.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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bff-0.2.1.tar.gz (33.3 kB view details)

Uploaded Source

File details

Details for the file bff-0.2.1.tar.gz.

File metadata

  • Download URL: bff-0.2.1.tar.gz
  • Upload date:
  • Size: 33.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1

File hashes

Hashes for bff-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1c31c124e012fa1d001730237cd81884014fa7e27e520edc0c73de15fb12bc56
MD5 a1ba612106b8f2c357985fb4cab842b3
BLAKE2b-256 4eb711b570c5354e39788925f00d791a0008fc4b3477e465f23ae365a7d12637

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page