TransparencyToolkit/Twiddler

Name: Twiddler

Owner: Transparency Toolkit

Description: A user friendly tool for text processing, light NLP, and keyword extraction

Created: 2015-08-21 17:51:59.0

Updated: 2017-11-21 13:38:25.0

Pushed: 2015-10-26 02:38:28.0

Homepage: https://transparnecytoolkit.org

Size: 272

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Twiddler

Twiddler is an application for text processing, light natural language processing, and keyword extraction. Twiddler is built around the idea that there are lots of various text processing tools and libraries in existence, but these existing tools are often highly technical and only provide portions of text processing. Twiddler aims to provide a framework to make using these tools more intuitive.

Installing

To install Twiddler do one of the following:

clone https://github.com/TransparencyToolkit/Twiddler
install twiddler

Then you need to install all of the dependencies that are required for Twiddler itself

widdler
install

These dependencies will give you all you need to run the basic Twiddler app via the CLI.

Here are some work in progress commands that provide some of the basic functionality

Running as CLI

new - add a new project

dler new /path/to/project/
-overwrite  // Overwrite exsting project
-save       // Scan folder of project and add sources

open - open an existing project

dler open /path/to/project/

source - adds a source to an existing project

dler source /path/to/project/ -t file

process - process a project

dler process /path/to/project/
Running the GUI app

First you need to download and install the devDependencies required by Electron

install --dev
start
Build the Electron App
run package

This will build the app for OS X, Linux, and Windows, using electron-packager.

License

AGPLv3 © TransparencyToolkit


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.