<commit_before>
# Enlighten

Ruby Gem for use with the Enphase "Elighten" API version 2

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'enlighten'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install enlighten_system

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( https://github.com/[my-github-username]/enlighten_system/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
<commit_msg>added some instructions to the README<commit_after>
# Enlighten

Ruby Gem for use with the Enphase "Elighten" API version 2

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'enlighten', :git => 'https://github.com/datadude/enlighten.git'
```

And then execute:

    $ bundle install


## Usage

### Rails
#### Configuraton

Add the following line to an initializer at `config/initializers/enlighten.rb`:

```ruby
Enlighten::System.config(
    key: '0960c4df1203f3079489fa8ccc251b59', user_id: '4d7a45774e6a41320a'
)
```

#### Controller

From the Example App: `https://github.com/datadude/enlighten-example`

```ruby
  def home
    @system = Enlighten::System.new(params[:id])
    @summary = @system.summary
    @inventory = @system.inventory
    @envoys = @system.envoys
    @production = @system.monthly_production(:start_date=>1.month.ago - 1.day)
    @stats = @system.stats(:start_at=>DateTime.new(Time.now.year,Time.now.month,Time.now.day,7,0), :end_at=>Time.now)
  end
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/enlighten_system/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

{'fraction_non_alphanumeric': 0.12934560327198363, 'fraction_numerical': 0.02607361963190184, 'mean_word_length': 4.232620320855615, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4239936', 'n_tokens_mistral': 711, 'n_tokens_neox': 650, 'n_words': 198}