<commit_before>## Gimlet

Gimlet is a NodeJS module for database access built on top of commonly used database drivers. It gives some high level validations and helper methods on top of returned rows. This is not an ORM/ODM, queries must still be made by hand (more or less..).

### Installation

Gimlet is available on NPM.

```sh
npm install gimlet
```

Since gimlet uses other drivers you must install the ones you need separately. For mysql just do:

```sh
npm install mysql
```

#### Drivers

Driver | Package
-------|--------
mysql  | mysql

#### Driver Registration

If you want to use another package to access the same database type, you can register the package.

```js
var gimlet = require("gimlet");

gimlet.register("mysql2", "mysql"); // 
```

### Usage
<commit_msg>Adds badges to README, fixes driver registration example<commit_after>## Gimlet

[![](https://badge.fury.io/js/gimlet.svg)](https://npmjs.org/package/gimlet)
[![](https://gemnasium.com/dresende/gimlet.png)](https://gemnasium.com/dresende/gimlet)

Gimlet is a NodeJS module for database access built on top of commonly used database drivers. It gives some high level validations and helper methods on top of returned rows. This is not an ORM/ODM, queries must still be made by hand (more or less..).

### Installation

Gimlet is available on NPM.

```sh
npm install gimlet
```

Since gimlet uses other drivers you must install the ones you need separately. For mysql just do:

```sh
npm install mysql
```

#### Drivers

Driver | Package
-------|--------
mysql  | mysql

#### Driver Registration

If you want to use another package to access the same database type, you can register the package.

```js
var gimlet = require("gimlet");

gimlet.register("mysql2", "mysql"); // will use mysql2 package with mysql integration

gimlet.connect("mysql2://...");
```

### Usage

{'fraction_non_alphanumeric': 0.12445887445887446, 'fraction_numerical': 0.0021645021645021645, 'mean_word_length': 3.9175531914893615, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '6972535', 'n_tokens_mistral': 572, 'n_tokens_neox': 542, 'n_words': 237}