<commit_before># Recurly

This library is the python client for Recurly's V3 API (or "partner api"). It's currently in the "Early Access" phase of development.
To learn more about early access to the next iteration of our API ecosystem, see [this link](https://dev.recurly.com/page/recurly-v3-api-early-access).

Documentation for the V3 API can be [found here](https://partner-docs.recurly.com).

## Getting Started

### Documentation

Documentation for the HTTP API can be [found here](https://partner-docs.recurly.com). This library does not yet have native documentation.

### Installing

This library is a pre-release. It can be be fetched from pypi by specifying the dependency in your setup.py or requirements.txt file.

```
recurly==3.0b1
```

It's important that you lock on a specific version as there may be breaking changes between releases.
All beta releases will have the format `3.0bx` until we go live with `3.0.0`.


### Importing the library

It's best to import recurly and preserve the namespace:

```python
import recurly
```

### Creating a client

Client instances are now explicitly created and referenced as opposed to
V2's use of global, statically initialized clients.

A client needs a site id and a private api key.

```python
api_key = '<KEY>'
site_id = 'dqzlv9shi7wa'
client = recurly.Client(site_id, api_key)
```

You can also use the `subdomain-` prefix in the site id to use your subdomain:

```python
api_key = '<KEY>'
site_id = 'subdomain-mycompanysubdomain'
client = recurly.Client(site_id, api_key)
```
<commit_msg>remove pypi instructions for now<commit_after># Recurly

This library is the python client for Recurly's V3 API (or "partner api"). It's currently in the "Early Access" phase of development.
To learn more about early access to the next iteration of our API ecosystem, see [this link](https://dev.recurly.com/page/recurly-v3-api-early-access).

Documentation for the V3 API can be [found here](https://partner-docs.recurly.com).

## Getting Started

### Documentation

Documentation for the HTTP API can be [found here](https://partner-docs.recurly.com). This library does not yet have native documentation.

### Installing

This library is a pre-release. It will be fetchable from pypi. In the meantime you will want to build from source.

### Importing the library

It's best to import recurly and preserve the namespace:

```python
import recurly
```

### Creating a client

Client instances are now explicitly created and referenced as opposed to
V2's use of global, statically initialized clients.

A client needs a site id and a private api key.

```python
api_key = '<KEY>'
site_id = 'dqzlv9shi7wa'
client = recurly.Client(site_id, api_key)
```

You can also use the `subdomain-` prefix in the site id to use your subdomain:

```python
api_key = '<KEY>'
site_id = 'subdomain-mycompanysubdomain'
client = recurly.Client(site_id, api_key)
```

{'fraction_non_alphanumeric': 0.09448275862068965, 'fraction_numerical': 0.006896551724137931, 'mean_word_length': 4.557471264367816, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, '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': '2689789', 'n_tokens_mistral': 903, 'n_tokens_neox': 859, 'n_words': 377}