https://github.com/byteclubfr/node-talon

Port of mailgun/talon (signature detection in mails) from Python to JavaScript
https://github.com/byteclubfr/node-talon

Last synced: 1 day ago
JSON representation

Port of mailgun/talon (signature detection in mails) from Python to JavaScript

• Host: GitHub
• URL: https://github.com/byteclubfr/node-talon
• Owner: byteclubfr
• License: mit
• Created: 2014-10-15T12:14:52.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-20T17:30:45.000Z (almost 2 years ago)
• Last Synced: 2024-04-10T02:15:16.886Z (7 months ago)
• Language: JavaScript
• Size: 254 KB
• Stars: 18
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://img.shields.io/travis/lmtm/node-talon/master.svg?style=flat)](https://travis-ci.org/lmtm/node-talon)

[![Dependency Status](https://david-dm.org/lmtm/node-talon.svg?style=flat)](https://david-dm.org/lmtm/node-talon)

[![devDependency Status](https://david-dm.org/lmtm/node-talon/dev-status.svg?style=flat)](https://david-dm.org/lmtm/node-talon#info=devDependencies)

node-talon

==========

Port of [mailgun/talon](https://github.com/mailgun/talon) (signature detection in mails) from Python to JavaScript.

This can be used to extract and strip signature from mail messages, allowing safer automatic parsing for example.

Installation

------------

```sh

npm install --save talon

```

Usage

-----

```js

var talon = require("talon");

var extractSignature = talon.signature.bruteforce.extractSignature;

var message = "Wow. Awesome!\n--\nBob Smith";

console.log(extractSignature(message));

```

expected output:

```

{ text: 'Wow. Awesome!', signature: '--\nBob Smith' }

```

Why the whole `talon.signature.bruteforce.extractSignature`?

------------------------------------------------------------

In the original library, there are multiple ways of extracting signatures. Here is implemented only one of the available methods, but I chose to keep the same namespace structure.

Roadmap

-------

### What's working?

* The bruteforce method of extracting signature

* Added French support

### What's not working?

* Everything else, including:

  * machine-learning way of extracting signature

  * quotations extraction

### What's planned?

* We'll need quotations handling very soon, so it will land fast

* The machine-learning thing is really not a priority