<commit_before>over-achiever
=============
A little demo app to show how to create a REST API with Flask.

Uses Flask-RESTful, SQLAlchemy and Flask-SQLAlchemy.

The only somewhat fancy stuff is a self-referential Goal model, which allows
creating arbitrarily deep hierarchies of goals and sub-goals.
<commit_msg>updated README to explain how use authenticate<commit_after>over-achiever
=============
A little demo app to show how to create a REST API with Flask.

Uses Flask-RESTful, SQLAlchemy and Flask-SQLAlchemy.

The only somewhat fancy stuff is a self-referential Goal model, which allows
creating arbitrarily deep hierarchies of goals and sub-goals.

Authentication
--------------
The over-achiever web app utilizes OAuth2 authentication via Github. You must
have a github account and hit the /login endpoint. This will direct you to
a Github login dialog, which will result in a page with a JSON 
response that includes a field called access-token. When you hit the API
you must provide the access token as a header


    curl -H "Access-Token:<the access token" http://localhost:5000/v1.0/goals

{'fraction_non_alphanumeric': 0.07789855072463768, 'fraction_numerical': 0.006340579710144928, 'mean_word_length': 4.23696682464455, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 3, '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': '4453225', 'n_tokens_mistral': 320, 'n_tokens_neox': 297, 'n_words': 152}