<commit_before>Rackspace Cloud Files Erlang Client
===================================

> Version 0.9 - Currently under initial development!

Description
-----------

This is an Erlang interface into the Rackspace Cloud Files service. It has been largely inspired by the existing [Ruby](http://github.com/rackspace/ruby-cloudfiles) API.


Building
--------

cferl relies on [rebar](http://bitbucket.org/basho/rebar/wiki/Home) for its build and dependency management and targets Erlang/OTP R13B04 or above.

Simply run:

    ./rebar get-deps compile eunit

Optinally, to generate the cferl documentation, run:

    ./rebar delete-deps doc

Optinally, to run the integration tests (and generate the code samples visible below), run:

    ./int_tests

If you run the integration tests, you'll need your API key and at least one pre-existing container. Note that a test container will be created and some queries could take a while if you have lots of containers.


Using
-----

cferl requires that the ssl and ibrowse applications be started prior to using it.

The following, which is output when running the integration tests, demonstrates a typical usage of the API. Refer to the documentation for the complete reference.
<commit_msg>added mention of Erlang version in readme<commit_after>Rackspace Cloud Files Erlang Client
===================================

Description
-----------

This is an Erlang interface into the Rackspace Cloud Files service. It has been largely inspired by the existing [Ruby](http://github.com/rackspace/ruby-cloudfiles) API.


Building
--------

*cferl* relies on [rebar](http://bitbucket.org/basho/rebar/wiki/Home) for its build and dependency management and targets Erlang/OTP R13B04 or above.

Simply run:

    ./rebar get-deps compile eunit

Optinally, to generate the *cferl* documentation, run:

    ./rebar delete-deps doc

Optinally, to run the integration tests (and generate the code samples visible below), run:

    ./int_tests

If you run the integration tests, you'll need your API key and at least one pre-existing container. Note that a test container will be created and some queries could take a while if you have lots of containers.


Using
-----

*cferl* has been developed on R13B04.

*cferl* requires that the ssl and ibrowse applications be started prior to using it.

The following, which is output when running the integration tests, demonstrates a typical usage of the API. Refer to the documentation for the complete reference.

{'fraction_non_alphanumeric': 0.09851226377161239, 'fraction_numerical': 0.0056292722155207075, 'mean_word_length': 3.91699604743083, 'pattern_counts': {'":': 0, '<': 3, '<?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': '2689890', 'n_tokens_mistral': 677, 'n_tokens_neox': 637, 'n_words': 324}