<commit_before># .

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

    gem '.'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install .

## Usage

TODO: Write usage instructions here
<commit_msg>update readme a bit<commit_after># PipelineDeals API gem

The PipelineDeals API gem is a nice ruby wrapper around the PipelineDeals API.  It will allow you full CRUD access to all of the core PipelieDeals components in a very easy-to-use library.

## Installation

Add this line to your application's Gemfile:

    gem 'pipeline_deals'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pipeline_deals

## Usage

First and foremost, register your api key:

```ruby
PipelineDeals.api_key = '<KEY>'
```


### Getting a single deal, person, or company:

```ruby
deal = Deal.find(1234)      # find the deal
deal.name = 'blah2'         # change an attribute
deal.save                   # re-save the deal to the site
deal.people                 # associations are respected
deal.people.first.id
deal.person_ids           
```

### Fetching collections of deals, people, or companies

```ruby
deals = Deal.find(:all)
deals = Deal.find(:all, params: {per_page: 5, page: 2})
deals = Deal.find(:all, params: {conditions: {deal_name: 'blah'}})
deals = Deal.where(conditions: {deal_name: 'blah'})
```

{'fraction_non_alphanumeric': 0.10028860028860029, 'fraction_numerical': 0.005050505050505051, 'mean_word_length': 3.334375, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, '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': '692279', 'n_tokens_mistral': 459, 'n_tokens_neox': 422, 'n_words': 162}