Skip to main content

Implements a powerful analytics library using Redis bitmaps.

Project description

bitmapist

Implements a powerful analytics library using Redis bitmaps.

This library makes it possible to implement real-time, highly scalable analytics that can answer following questions:

  • Has user 123 been online today? This week? This month?

  • Has user 123 performed action “X”?

  • How many users have been active have this month? This hour?

  • How many unique users have performed action “X” this week?

  • How many % of users that were active last week are still active?

  • How many % of users that were active last month are still active this month?

This library is very easy to use and enables you to create your own reports easily.

Using Redis bitmaps you can store events for millions of users in a very little amount of memory (megabytes). You should be careful about using huge ids (e.g. 2^32 or bigger) as this could require larger amounts of memory.

Now with Cohort charts! Read more here:

If you want to read more about bitmaps please read following:

Requires Redis 2.6+ and newest version of redis-py.

Examples

Setting things up:

from datetime import datetime, timedelta
from bitmapist import setup_redis, delete_all_events, mark_event,                          MonthEvents, WeekEvents, DayEvents, HourEvents,                          BitOpAnd, BitOpOr

now = datetime.utcnow()
last_month = datetime.utcnow() - timedelta(days=30)

Mark user 123 as active and has played a song:

mark_event('active', 123)
mark_event('song:played', 123)

Answer if user 123 has been active this month:

assert 123 in MonthEvents('active', now.year, now.month)
assert 123 in MonthEvents('song:played', now.year, now.month)
assert MonthEvents('active', now.year, now.month).has_events_marked() == True

How many users have been active this week?:

print len(WeekEvents('active', now.year, now.isocalendar()[1]))

Perform bit operations. How many users that have been active last month are still active this month?:

active_2_months = BitOpAnd(
    MonthEvents('active', last_month.year, last_month.month),
    MonthEvents('active', now.year, now.month)
)
print len(active_2_months)

# Is 123 active for 2 months?
assert 123 in active_2_months

Work with nested bit operations (imagine what you can do with this ;-)):

active_2_months = BitOpAnd(
    BitOpAnd(
        MonthEvents('active', last_month.year, last_month.month),
        MonthEvents('active', now.year, now.month)
    ),
    MonthEvents('active', now.year, now.month)
)
print len(active_2_months)
assert 123 in active_2_months

# Delete the temporary AND operation
active_2_months.delete()

As something new tracking hourly is disabled (to save memory!) To enable it as default do:

import bitmapist
bitmapist.TRACK_HOURLY = True

Additionally you can supply an extra argument to mark_event to bypass the default value:

mark_event('active', 123, track_hourly=False)

Copyright: 2012 by Doist Ltd.

Developer: Amir Salihefendic ( http://amix.dk )

License: BSD

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

bitmapist-3.101.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

bitmapist-3.101-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

Details for the file bitmapist-3.101.tar.gz.

File metadata

  • Download URL: bitmapist-3.101.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for bitmapist-3.101.tar.gz
Algorithm Hash digest
SHA256 7dcc18a0e7fe14706fb61bb97f1acfbc19d93f27455255325378d81fcbed330b
MD5 4aeb4a0172a865d5153aceaf8412fd9f
BLAKE2b-256 e933d4bd2eaecb268dd5fdf294914a4535d5213eb4b71e3c7b055de27ca57003

See more details on using hashes here.

Provenance

File details

Details for the file bitmapist-3.101-py3-none-any.whl.

File metadata

File hashes

Hashes for bitmapist-3.101-py3-none-any.whl
Algorithm Hash digest
SHA256 f3ab11eb4513a4a70622b627f7d6ed1a677004a907739ccfb4cc8a8fd487f7dd
MD5 71847cb681b39e7452bfec16f1e9abc9
BLAKE2b-256 9ee3ad2730d65b797f5594359b2e8956e99b8a2ce16216987474980e5695f58c

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