Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Library for calculating win/loss streaks using Redis as a backend

Project description

# streak

streak is a library for calculating win/loss streaks. It uses Redis as its backend for collecting the data.
This is a Python port of the original [streak](https://github.com/czarneckid/streak) Ruby gem.

## Installation

## Usage

```python
>>> from streak import Streak
>>> streak = Streak()
>>> streak.aggregate('david', 3)
>>> streak.aggregate('david', -2)
>>> streak.aggregate('david', 5)
>>> streak.aggregate('david', -1)
>>> statistics = streak.statistics('david')
>>> print statistics
{'losses_streak': 2, 'wins_streak': 5, 'wins': 0, 'losses_total': 3, 'losses': 1, 'wins_total': 8, 'total': 11}
>>> streak.reset_statistics('david')
>>> statistics = streak.statistics('david')
>>> print statistics
{'losses_streak': 0, 'wins_streak': 0, 'wins': 0, 'losses_total': 0, 'losses': 0, 'wins_total': 0, 'total': 0}
>>>
```

You can also configure the keys used in Redis:

```python
>>> streak = Streak(dict(
namespace = 'streak',
positive_key = 'kills',
positive_total_key = 'kills_total',
positive_streak_key = 'kills_streak',
negative_key = 'deaths',
negative_total_key = 'deaths_total',
negative_streak_key = 'deaths_streak',
total_key = 'total'
))
```

If you need to set the Redis instance to something other than `localhost:6379/0`, you can do:

```python
streak.redis = redis.StrictRedis(host = 'some.host', port = 6379, db = 7)
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Copyright

Copyright (c) 2012 David Czarnecki. See LICENSE for further details.

Project details


Release history Release notifications

This version
History Node

0.0.1

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page