## RiTa: tools for computational writing
RiTa is implemented in JS, Java & Python with a common [API](https://rednoise.org/rita/reference/) - it is free/libre & open-source.
### Features
* Smart lexicon search for words matching part-of-speech, syllable, stress and rhyme patterns
* Heuristic algorithms for inflection, conjugation, stemming, tokenization, and more
* A powerful letter-to-sound engine for feature analysis of arbitrary words
* Integration of the grammar-based [RiScript](https://observablehq.com/@dhowe/riscript) scripting language for writers
* New generation options via grammars and unbounded Markov chains
* Published in ESM, CommonJS and as an IIFE
See the full [API reference here](https://rednoise.org/rita/index.html#reference)
### Installation
* For [esm](#an-esm-browser-sketch): ```import { RiTa } from "https://esm.sh/rita";```
* For [node](#with-nodejs-and-npm): `$ npm install rita`
```let { RiTa } = require('rita');```
* For [browsers](#a-simple-browser-sketch): ``````
* For [p5.js](#with-p5js): ``````
* For [developers](#developing)
### Example
```javascript
import { RiTa } from "https://esm.sh/rita";
// to analyze a sentence
let data = RiTa.analyze("The elephant took a bite!");
console.log(data);
// to load a grammar
let grammar = RiTa.grammar(rulesObjectOrJSON);
console.log(grammar.expand());
```
## RiScript
[RiScript](https://github.com/dhowe/riscript) (the minor language that powers RiTa) was designed specifically for writers working with code. RiScript primitives (choices, symbols, gates, transforms, etc) can be used as part of any RiTa [grammar](https://rednoise.org/rita/reference/RiTa/grammar/) or executed directly using [RiTa.evaluate](https://rednoise.org/rita/reference/RiTa/evaluate/). For more info, see this interactive [notebook](https://observablehq.com/@dhowe/riscript) on observable.
## Developing
To install/build the library and run tests:
```sh
$ git clone https://github.com/dhowe/rita.git
$ cd rita/js
$ npm install
$ npm run build
$ npm test
```
If all goes well, you should see a list of successful tests and find the library built in 'dist'
Please make contributions via [fork-and-pull](https://reflectoring.io/github-fork-and-pull/) - thanks!
## About
* Author: [Daniel C. Howe](http://rednoise.org/daniel)
* Web Site: [https://rednoise.org/rita](http://rednoise.org/rita)
* Github Repo: [https://github.com/dhowe/rita](https://github.com/dhowe/rita)
* Issues: [https://github.com/dhowe/rita/issues](https://github.com/dhowe/rita/issues)
* Reference: [https://rednoise.org/rita/reference](http://rednoise.org/rita/reference)
* RiScript: [https://github.com/dhowe/riscript](https://github.com/dhowe/riscript)
## Quick Start
#### A simple browser sketch
Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
```html
```
#### An ESM browser sketch
Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
```html
```
#### With [p5.js](http://p5js.org/)
Create a new file on your desktop called 'test.html' with the following lines, save and drag it into a browser:
```html
```
If you already have a sketch, simply add `` to your index.html to include RiTa.
#### With [node.js](http://nodejs.org/) and [npm](https://www.npmjs.com/)
To install: `$ npm install rita`
```javascript
let RiTa = require('rita');
let data = RiTa.analyze("The elephant took a bite!");
console.log(data);
```
## Contributors
### Code Contributors
This project exists only because of the people who contribute. Thank you!
### Financial Contributors
