<commit_before>[![Build Status](https://travis-ci.org/henridf/apache-spark-node.svg?branch=master)](https://travis-ci.org/henridf/apache-spark-node)

apache-spark-node
=================

Node.js bindings for Apache Spark.


*Work in progress:* This project is already usable in its present form, but it is still pretty early
on. Notably not yet implemented are:

- support for user-defined functions
- jvm-side helpers to for functions/methods which cannot currently be called
  from node (because they take parameters types like `Seq`)

APIs are still likely to change.


Getting started
---------------<commit_msg>README: add ToC and clarify status<commit_after>[![Build Status](https://travis-ci.org/henridf/apache-spark-node.svg?branch=master)](https://travis-ci.org/henridf/apache-spark-node)

Apache Spark <=> Node.js
========================

Node.js bindings for Apache Spark.

**Table of Contents**

- [Status](#status)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Examples](#examples)
- [Misc notes](#misc-notes)


Status
------

This project is already usable in its present form, but it is still in early
stages and under development. APIs may change. Notably not yet implemented
are:

- support for user-defined functions
- jvm-side helpers to for functions/methods which cannot currently be called
  from node (for example because they take parameters types like `Seq`)



Getting started
---------------
{'fraction_non_alphanumeric': 0.15293296089385475, 'fraction_numerical': 0.0, 'mean_word_length': 4.154676258992806, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, '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': '4896724', 'n_tokens_mistral': 433, 'n_tokens_neox': 395, 'n_words': 145}