<commit_before>Open Energy Efficiency Meter 
============================

![Build status](https://travis-ci.org/openeemeter/eemeter.svg?branch=develop)
[![Coverage Status](https://coveralls.io/repos/github/openeemeter/eemeter/badge.svg?branch=develop)](https://coveralls.io/github/openeemeter/eemeter?branch=develop)

Documentation
-------------

See [openee.io](https://www.openee.io/open-source/get-started).

Dev Installation (OSX)
----------------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ mkvirtualenv eemeter
    (eemeter)$ pip install -e .
    (eemeter)$ pip install -r dev_requirements.txt
    (eemeter)$ workon # gives you access to virtualenv py.test executable

Dev Installation (Linux)
----------------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ virtualenv eemeter
    $ source eemeter/bin/activate
    (eemeter)$ pip install -r dev_requirements.txt
    (eemeter)$ pip install -e .

Docker Installation
----------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ docker-compose build

Testing
-------

This library uses the py.test framework. To develop locally, clone the repo,
and in a virtual environment execute the following commands:

    $ py.test

Alternatively, to run tests through docker, execute the following commands: 

    $ docker-compose run test

If you run into problems with the py.test executable, please ensure that you
are using the virtualenv py.test:

    $ py.test --version

Licence
-------

MIT
<commit_msg>Update README.md after MIT->Apache license change<commit_after>Open Energy Efficiency Meter 
============================

![Build status](https://travis-ci.org/openeemeter/eemeter.svg?branch=develop)
[![Coverage Status](https://coveralls.io/repos/github/openeemeter/eemeter/badge.svg?branch=develop)](https://coveralls.io/github/openeemeter/eemeter?branch=develop)

Documentation
-------------

See [openee.io](https://www.openee.io/open-source/get-started).

Dev Installation (OSX)
----------------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ mkvirtualenv eemeter
    (eemeter)$ pip install -e .
    (eemeter)$ pip install -r dev_requirements.txt
    (eemeter)$ workon # gives you access to virtualenv py.test executable

Dev Installation (Linux)
----------------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ virtualenv eemeter
    $ source eemeter/bin/activate
    (eemeter)$ pip install -r dev_requirements.txt
    (eemeter)$ pip install -e .

Docker Installation
----------------

    $ git clone https://github.com/openeemeter/eemeter
    $ cd eemeter
    $ docker-compose build

Testing
-------

This library uses the py.test framework. To develop locally, clone the repo,
and in a virtual environment execute the following commands:

    $ py.test

Alternatively, to run tests through docker, execute the following commands: 

    $ docker-compose run test

If you run into problems with the py.test executable, please ensure that you
are using the virtualenv py.test:

    $ py.test --version

Licence
-------

[Apache-2.0](LICENSE)

{'fraction_non_alphanumeric': 0.16447368421052633, 'fraction_numerical': 0.0006265664160401002, 'mean_word_length': 2.9713930348258706, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, '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': '2029972', 'n_tokens_mistral': 1003, 'n_tokens_neox': 920, 'n_words': 259}