https://github.com/timdorr/reparty

:chart_with_upwards_trend: A business analytics reporting party!
https://github.com/timdorr/reparty

Last synced: 12 months ago
JSON representation

:chart_with_upwards_trend: A business analytics reporting party!

• Host: GitHub
• URL: https://github.com/timdorr/reparty
• Owner: timdorr
• License: mit
• Created: 2013-04-26T05:13:07.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2013-06-21T18:14:29.000Z (about 13 years ago)
• Last Synced: 2025-06-08T22:30:12.542Z (about 1 year ago)
• Language: Ruby
• Homepage: http://rubygems.org/gems/reparty
• Size: 336 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Reparty [![Build Status](https://travis-ci.org/timdorr/reparty.png?branch=master)](https://travis-ci.org/timdorr/reparty) [![Dependency Status](https://gemnasium.com/timdorr/reparty.png)](https://gemnasium.com/timdorr/reparty) [![Code Climate](https://codeclimate.com/github/timdorr/reparty.png)](https://codeclimate.com/github/timdorr/reparty)

__A business analytics reporting party!__

Although initially concentrating on a daily email report, Reparty intends to be an easy 

tool for generating reports focused on business analytics about your app.

A modular design is used, so reporting on a variety of different data sources is possible.

Custom modules can be created within your app. The currently bundled modules are:

* ActiveRecord, including arbitrary sum/count columns

* SendGrid

* Mixpanel (funnels and engagement for now)

Other modules will be added over time. This is in use in production at my company, SalesLoft,

so focus will be on the modules that best suit our needs. Feel free to submit a pull request

with any modules you have created.

## Configuration

You can configure Reparty in an initalizer using a config block:

    Reparty.config do |config|

      config.from = "test@test.com"

      config.subject = "SalesLoft JCA Daily Report"

    

      config.add_report Reparty::Report::ActiveRecord, "New User Signups", :user

    end

Better documentation of Reparty and each individual module's configuration is coming. For now,

 you'll just have to read the code (sorry!). Check the test suite for examples.

## Usage

Generating an email is as simple as a rake task:

    rake reparty:email[someone@somewhere.com]

You can run this in a cron job or other scheduling system. A weekly email is currently hacked

in to the code, which you can run using it's separate rake task:

    rake reparty:weekly_email[someone@somewhere.com]

This will likely change in the future, so watch out when upgrading!