Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.63 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.63 KB

Platypus Analytics

Build Status Documentation Status

Python library for Platypus data analysis.

⚠️ This library is currently under development! Some of the functionality in the library may be incomplete or untested.

Quickstart

The easiest way to install is via pip:

$ pip install git+https://github.com/platypusllc/analytics.git

Documentation

  • API documentation can be found on ReadTheDocs.
  • Usage examples of this library can be found in the examples directory.

Development

If you would like to develop the library, you can install the library with the --editable/-e option. If you do this, you may want to consider using a python virtual environment. Two popular options are virtualenv and anaconda:

Standalone:

$ git clone https://github.com/platypusllc/analytics.git
$ pip install -e analytics

Virtualenv:

$ virtualenv ./venv
$ . ./venv/bin/activate
$ pip install -e git+https://github.com/platypusllc/analytics.git#egg=platypus-analytics
$ cd ./venv/src/platypus-analytics

Anaconda:

$ conda create -n platypus
$ source activate platypus
$ pip install -e git+https://github.com/platypusllc/analytics.git#egg=platypus-analytics