Installation

The two primary methods for installing/using the functionality provided by the frequent package: installing the package or copying the file(s) for the component(s) you need (vendorization). You can also install the latest version from source.

Package Installation

To install frequent from the PyPI package, using your package manager of choice (in my case Pipenv):

$ pipenv install frequent

Vendorization

Important

Be sure to attribute vendorized modules to this project by not modifying the headers of the copied files containing information about the the project.

Taking a cue from the excellent boltons package, each component is self-contained in its respective file making this process simple. Components are not dependent on one another and rely solely on the standard Python library. The unit tests for each module are similarly organized (though written targeting PyTest). Just copy the module(s) you need and (optionally) the associated test_<module>.py file(s) and you’re good to go!

Source Code

To install (or use the latest version) from source you can clone the Github repository:

$ git clone https://github.com/douglasdaly/frequent-py

The release branch should always represent the latest, unit-tested and stable version of frequent. For the latest development version see the develop branch.

To install (in edit mode), once you’ve cloned the repository run:

$ cd frequent-py/
$ pipenv install -e .