<commit_before>habanero
=======

[![Build Status](https://travis-ci.org/sckott/habanero.svg)](https://travis-ci.org/sckott/habanero)
[![codecov.io](https://codecov.io/github/sckott/habanero/coverage.svg?branch=master)](https://codecov.io/github/sckott/habanero?branch=master)

This is a low level client for working with Crossref's search API. It's been named to be more generic, as other organizations are/will adopt Crossref's search API, making it possible to ineract with all from one client. 

Crossref API docs: [https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md](https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md)

Other Crossref API clients:

- Ruby: [serrano](https://github.com/sckott/serrano)
- R: [rcrossref](https://github.com/ropensci/rcrossref)

`habanero` includes methods matching Crossref API routes:

- `/works`
- `/members`
- `/prefixes`
- `/fundref`
- `/journals`
- `/types`
- `/licenses`

### Installation

```
sudo pip install git+git://github.com/sckott/habanero.git#egg=habanero
```

OR 

```
git clone git@github.com:sckott/habanero.git
cd habanero
make install
```

### Usage

Initialize

```python
from habanero import Habanero
hb = Habanero()
```

Works route

```python
x = hb.works(query = "ecology")
x.status()
x.message()
x.total_results()
x.items()
```

Members route

```python
hb.members(ids = 98, works = True)
```

### License

MIT; see [LICENSE](LICENSE) for details
<commit_msg>add coveralls badge to readme<commit_after>habanero
=======

[![Build Status](https://travis-ci.org/sckott/habanero.svg)](https://travis-ci.org/sckott/habanero)
[![Coverage Status](https://coveralls.io/repos/sckott/habanero/badge.svg?branch=master&service=github)](https://coveralls.io/github/sckott/habanero?branch=master)

This is a low level client for working with Crossref's search API. It's been named to be more generic, as other organizations are/will adopt Crossref's search API, making it possible to ineract with all from one client. 

Crossref API docs: [https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md](https://github.com/CrossRef/rest-api-doc/blob/master/rest_api.md)

Other Crossref API clients:

- Ruby: [serrano](https://github.com/sckott/serrano)
- R: [rcrossref](https://github.com/ropensci/rcrossref)

`habanero` includes methods matching Crossref API routes:

- `/works`
- `/members`
- `/prefixes`
- `/fundref`
- `/journals`
- `/types`
- `/licenses`

### Installation

```
sudo pip install git+git://github.com/sckott/habanero.git#egg=habanero
```

OR 

```
git clone git@github.com:sckott/habanero.git
cd habanero
make install
```

### Usage

Initialize

```python
from habanero import Habanero
hb = Habanero()
```

Works route

```python
x = hb.works(query = "ecology")
x.status()
x.message()
x.total_results()
x.items()
```

Members route

```python
hb.members(ids = 98, works = True)
```

### License

MIT; see [LICENSE](LICENSE) for details

{'fraction_non_alphanumeric': 0.16678035470668487, 'fraction_numerical': 0.001364256480218281, 'mean_word_length': 4.739726027397261, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, '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': '693334', 'n_tokens_mistral': 1113, 'n_tokens_neox': 1059, 'n_words': 229}