<commit_before># atlas

Atlas is a Ruby client for [Hashicorp][]'s [Atlas][].

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'atlas'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install atlas

## Usage

TBD.

## Contributing

1. Fork it ( https://github.com/[my-github-username]/atlas/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

## Author

Copyright (c) 2015 <NAME> <<EMAIL>><commit_msg>Documents basic usage.<commit_after># atlas

Atlas is a Ruby client for [Hashicorp][]'s [Atlas][].

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'atlas'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install atlas

## Usage

`atlas` uses a simple, ActiveRecord-style approach:

```ruby
# first, configure with the token from Atlas
Atlas.configure do |config|
    config.access_token = ''
end

# then you can load in users (creating, updating, etc isn't supported by Atlas)
user = Atlas::User.load('nickcharlton')
#=> <Atlas::User username=nickcharlton...>

# or access boxes, their versions and providers
box = Atlas::Box.load('nickcharlton', 'example-box')
#=> <Atlas::Box name=example-box'...>

# or create a new box
new_box = Atlas::Box.create(name: 'new-box')
new_box.save
```

It aims to support most of the functionality listed in the [Atlas API
Documentation][].

## Contributing

1. Fork it ( https://github.com/nickcharlton/atlas/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

## Author

Copyright (c) 2015 <NAME> <<EMAIL>>

[Atlas API Documentation]: https://atlas.hashicorp.com/docs
{'fraction_non_alphanumeric': 0.13347022587268995, 'fraction_numerical': 0.009240246406570842, 'mean_word_length': 4.115485564304462, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 13, 'https://': 3, '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': '6731134', 'n_tokens_mistral': 675, 'n_tokens_neox': 631, 'n_words': 235}