<commit_before>= GoodData Ruby wrapper and CLI

A convenient Ruby wrapper around the GoodData RESTful API.

This is a two-in one tool. It both contains a wrapper class called Gooddata::Client
that you can use in your own projects and a CLI for use on the prompt.

The best documentation for the API can be found using these resources:
* http://developer.gooddata.com/api
* https://secure.gooddata.com/gdc

== Usage

Since this project is in its early stages, no gem have been released to rubygems.org yet.
To install the gooddata gem, you instead have to first checkout this repository. Then install
the gem using the rake task:

  rake install

Now you are ready to use either the Ruby wrapper class or the CLI.

Alternatively you can run the source code directly. For details about this approge, see {the
Development Wiki page}[http://github.com/gooddata/gooddata-ruby/wiki/Development].

=== Wrapper class usage

For details of how to use the Ruby wrapper class, see the Gooddata::Client RDoc.

=== CLI Usage

After installing the gooddata gem, GoodData is available from your command line using
the <tt>gooddata</tt> command. To get a complete overview of possible options type:

  gooddata --help

The examples and descriptions below does not cover all the options available via the CLI.
So remember to refer back to the <tt>--help</tt> mode.

Before you do anything else, a good idea is to see if your account is set up correctly and 
that you can log in. To do this, use the test-mode:

  gooddata --test

==== Authentication

As you saw if you ran the above test command <tt>gooddata</tt> will prompt you for your GoodData username
and password. Alternatively you can also specify it using the command line options <tt>--username</tt><commit_msg>Fixed spelling<commit_after>= GoodData Ruby wrapper and CLI

A convenient Ruby wrapper around the GoodData RESTful API.

This is a two-in one tool. It both contains a wrapper class called Gooddata::Client
that you can use in your own projects and a CLI for use on the prompt.

The best documentation for the API can be found using these resources:
* http://developer.gooddata.com/api
* https://secure.gooddata.com/gdc

== Usage

Since this project is in its early stages, no gem have been released to rubygems.org yet.
To install the gooddata gem, you instead have to first checkout this repository. Then install
the gem using the rake task:

  rake install

Now you are ready to use either the Ruby wrapper class or the CLI.

Alternatively you can run the source code directly. For details about this approach, see {the
Development Wiki page}[http://github.com/gooddata/gooddata-ruby/wiki/Development].

=== Wrapper class usage

For details of how to use the Ruby wrapper class, see the Gooddata::Client RDoc.

=== CLI Usage

After installing the gooddata gem, GoodData is available from your command line using
the <tt>gooddata</tt> command. To get a complete overview of possible options type:

  gooddata --help

The examples and descriptions below does not cover all the options available via the CLI.
So remember to refer back to the <tt>--help</tt> mode.

Before you do anything else, a good idea is to see if your account is set up correctly and 
that you can log in. To do this, use the test-mode:

  gooddata --test

==== Authentication

As you saw if you ran the above test command <tt>gooddata</tt> will prompt you for your GoodData username
and password. Alternatively you can also specify it using the command line options <tt>--username</tt>
{'fraction_non_alphanumeric': 0.05868945868945869, 'fraction_numerical': 0.0, 'mean_word_length': 4.103197674418604, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3565193', 'n_tokens_mistral': 947, 'n_tokens_neox': 893, 'n_words': 532}