<commit_before>STAT API
=========

A simple wrapper around the getstat.com API.<commit_msg>Extend readme<commit_after>STAT API
=========

A simple wrapper around the getstat.com API.

# Usage example

```python
from stat_api import Stat
subdomain = 'try'
api_key = 'yourapikey'
stat = Stat(subdomain, api_key)
project_id = 999
data = stat.request("/sites/list", project_id=project_id)
```

`data` should now be a Python object of the returned sites as per the [documentation](https://help.getstat.com/knowledgebase/requests-and-responses/#sites-list).
{'fraction_non_alphanumeric': 0.13611615245009073, 'fraction_numerical': 0.0054446460980036296, 'mean_word_length': 5.571428571428571, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '1581221', 'n_tokens_mistral': 181, 'n_tokens_neox': 169, 'n_words': 52}