Metadata-Version: 2.4
Name: dstoolbox
Version: 0.14.0
Summary: Tools that make working with scikit-learn and pandas easier.
Home-page: https://github.com/ottogroup/dstoolbox
Download-URL: https://github.com/ottogroup/dstoolbox/tarball/0.14.0
Author: Otto Group
Author-email: benjamin.bossan@ottogroup.com
License-File: LICENSE
Requires-Dist: numpy>=1.22.3
Requires-Dist: pandas>=1.4.2
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pytz>=2022.1
Requires-Dist: scikit-learn>=1.1.0
Requires-Dist: scipy>=1.8.0
Requires-Dist: six>=1.16.0
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Provides-Extra: docs
Requires-Dist: Sphinx; extra == "docs"
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

Otto Group BI Data Science Toolbox
==================================

NOTE: This project is on life support. That means there are probably
not any new features being added, but there will be regular updates to
support upcoming versions of sklearn and pandas.

This repository contains tools that make working with
`scikit-learn <http://scikit-learn.org/>`__ and
`pandas <http://pandas.pydata.org/>`__ easier.

|Build Status|

What is this?
-------------

dstoolbox is not one big tool but rather an amalgamation of small
re-usable tools. They are intended to work well with scikit-learn and
pandas make the integration of those libraries easier.

The best way to get started is to have a look at the `notebooks
folder <https://github.com/ottogroup/dstoolbox/tree/master/notebooks>`__,
especially at the `showcase
notebook <https://github.com/ottogroup/dstoolbox/blob/master/notebooks/Showcase.ipynb>`__.

The tools included here are used by us at Otto Group BI for our
production services, as well as by individual members for machine
learning related things, such as participating in Kaggle competitions.

Installation instructions
-------------------------

Using ``pip``::

  pip install dstoolbox


There is a conda recipe for those who want to build their own conda
package.


Contributing
------------

Pull requests are welcome. Here are some directions:

Tests
~~~~~

To run the tests, you need to install the dev requirements using pip::

  pip install -r requirements-dev.txt

or conda::

  conda install --file requirements-dev.txt

Next you should check that all unit tests and all static code checks
pass::

  py.test
  pylint dstoolbox

Guidelines
~~~~~~~~~~

-  Python 3 only.

-  Code should be re-usable and succinct.

-  Where applicable, it should be compatible with
   `scikit-learn <http://scikit-learn.org/>`__,
   `pandas <http://pandas.pydata.org/>`__, and
   `Palladium <https://github.com/ottogroup/palladium>`__.

-  It should be documented and unit-tested using pytest (100% code
   coverage desired).

-  It should conform to the coding standards prescribed by pylint (where
   it makes sense).

-  There should be usage examples that cover the most common use cases
   (the best place would be an IPython/Jupyter notebook).

-  Don't add dependencies unless absolutely necessary.


.. |Build Status| image:: https://github.com/ottogroup/dstoolbox/actions/workflows/build_test_python.yml/badge.svg
   :target: https://github.com/ottogroup/dstoolbox/actions/workflows/build_test_python.yml
