Skip to main content

Crunch.io Cube library

Project description

crunch-cube

Build Status Coverage Status Documentation Status


Open Source Python implementation of the API for working with CrunchCubes

Introduction

This package contains the implementation of the CrunchCube API. It is used to extract useful information from CrunchCube responses (we'll refer to them as cubes in the subsequent text). Cubes are obtained from the Crunch.io platform, as JSON responses to the specific queries created by the user. These queries specify which data the user wants to extract from the Crunch.io system. The most common usage is to obtain the following:

  • Cross correlation between different variable
  • Margins of the cross tab cube
  • Proportions of the cross tab cube (e.g. proportions of each single element to the entire sample size)
  • Percentages

When the data is obtained from the Crunch.io platform, it needs to be interpreted to the form that's convenient for a user. The actual shape of the cube JSON contains many internal details, which are not of essence to the end-user (but are still necessary for proper cube functionality).

The job of this library is to provide a convenient API that handles those intricacies, and enables the user to quickly and easily obtain (extract) the relevant data from the cube. Such data is best represented in a table-like format. For this reason, the most of the API functions return some form of the ndarray type, from the numpy package. Each function is explained in greater detail, uner its own section, under the API subsection of this document.

Installation

The cr-cube package can be installed by using the pip install:

pip install cr-cube

For developers

For development mode, cr.cube needs to be installed from the local checkout of the crunch-cube repository. It is strongly advised to use virtualenv. Assuming you've created and activated a virtual environment venv, navigate to the top-level folder of the repo, on the local file system, and run:

pip install -e .

or

python setup.py develop

Running tests

To setup and run tests, you will need to install cr.cube as well as testing dependencies. To do this, from the root directory, simply run:

pip install -e .[testing]

And then tests can be run using py.test in the root directory:

pytest

Usage

After the cr.cube package has been successfully installed, the usage is as simple as:

>>> from cr.cube.cube import Cube

>>> ### Obtain the crunch cube JSON payload using app.crunch.io, pycrunch, rcrunch or scrunch
>>> ### And store it in the 'cube_JSON_response' variable

>>> cube = Cube(cube_JSON_response)
>>> print(cube)
Cube(name='MyCube', dimension_types='CAT x CAT')
>>> cube.counts
np.array([[1169, 547],
          [1473, 1261]])

Complete API Doc

Please visit https://crunch-cube.readthedocs.io/en/latest for the API reference.


Changes

3.1.5

  • Add audience ratio measure

3.1.4

  • Sort column by opposing row

3.1.3

  • Bug fix for _Strand.table_percentages

3.1.2

  • Bug fix for scale mean diff rows and cols

3.1.1

  • Bug fix for subtotal diff (wave difference) for categorical date dimensions

3.1.0

  • Subtotal diff (wave difference) for categorical date dimensions

3.0.45

  • Enumerator refactoring

3.0.44

  • Bug fix median measure for exporter

For a complete list of changes see history.

Project details


Release history Release notifications | RSS feed

This version

3.1.5

Download files

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

Source Distribution

cr_cube-3.1.5.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

cr_cube-3.1.5-py3-none-any.whl (117.0 kB view details)

Uploaded Python 3

File details

Details for the file cr_cube-3.1.5.tar.gz.

File metadata

  • Download URL: cr_cube-3.1.5.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for cr_cube-3.1.5.tar.gz
Algorithm Hash digest
SHA256 1c47bf01f101b2019041b44b11c86473ebadf19b3e9a428453e124086c6c23c2
MD5 c94cd7e8323bb78cd1c07503ab2b9625
BLAKE2b-256 edba78867ea6871dca0c494bc39fb3907b2e65ba09f697d9358b53eb3d8b928d

See more details on using hashes here.

File details

Details for the file cr_cube-3.1.5-py3-none-any.whl.

File metadata

  • Download URL: cr_cube-3.1.5-py3-none-any.whl
  • Upload date:
  • Size: 117.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for cr_cube-3.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2fece5b096c9af5efa4584eb12bdee23c6ca27ad43d24b3cebb2c0b1298a78f1
MD5 430350de4c0db3bb87c4d0e46d9e809d
BLAKE2b-256 53a87f16ca0ceaf9f9d79d69cd51aefc989075658e7b8ebabf7c5d1583e9940c

See more details on using hashes here.

Supported by

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