# snip-it

> ## Installation

Latest version **1.0.5** (published 2017-05-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install snip-it
pnpm add snip-it
yarn add snip-it
bun add snip-it
```

Provides the command `snip-it`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2017-05-29 |
| First published | 2017-04-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | mindmelting |

## Links

- npm: https://www.npmjs.com/package/snip-it
- Repository: https://github.com/mindmelting/snip-it
- Homepage: https://github.com/mindmelting/snip-it#readme
- Issues: https://github.com/mindmelting/snip-it/issues
- npm.io page: https://npm.io/package/snip-it

## Dependencies (6)

- [glob](https://npm.io/package/glob.md) ^7.1.1
- [path](https://npm.io/package/path.md) ^0.12.7
- [xlsx](https://npm.io/package/xlsx.md) ^0.9.7
- [yargs](https://npm.io/package/yargs.md) ^7.0.2
- [fluent-ffmpeg](https://npm.io/package/fluent-ffmpeg.md) ^2.1.0
- [@google-cloud/speech](https://npm.io/package/@google-cloud/speech.md) ^0.7.0

## Recent versions

- 1.0.5 (latest) — 2017-05-29
- 1.0.4 — 2017-04-11
- 1.0.3 — 2017-04-04
- 1.0.2 — 2017-04-03
- 1.0.1 — 2017-04-03
- 1.0.0 — 2017-04-02

## README

# Snip-It

## Installation

### Prerequisites
* [NodeJS](https://nodejs.org/en/download/current/)
* [FFmpeg](https://ffmpeg.org/)
  * [FFmpeg Tutorial - Mac](http://ericholsinger.com/install-ffmpeg-on-a-mac)

### Transcription Prerequisite
For automatic transcription via Google Cloud Speech API, an account will need to be setup with [Google Cloud](https://console.cloud.google.com).

Instructions can be found here: [https://github.com/GoogleCloudPlatform/google-cloud-node#elsewhere](https://github.com/GoogleCloudPlatform/google-cloud-node#elsewhere)  

The `keystore.json` file generated should be stored safely, and it will be used when the tool is run if transcription is to be used.

### Install Snip It

In the command line execute the following to install the tool:  
```bash
npm install -g snip-it
```

## Using

The tool operates on the macro enabled Interview Recording spreadsheet. Once an interview has been concluded the spreadsheet should be saved with a filename that matches the video filename. e.g. `interview-user1.xlsx` and `interview-user1.mp4`.  

The video should be placed in a `video` folder, an example directory may look like the following:

```
├── interviews/
│   ├── interview-user1.xlsx
│   ├── interview-user2.xlsx
│   ├── video
│   │   ├── interview-user1.mp4
│   │   ├── interview-user1.mp4
```

In the above directory structure, navigate to `interviews` and run:  

```bash
snip-it
```

This will create a folder called `output` which will contain the segmented videos based upon the timestamps created in the spreadsheet.  

## Transcription

Enabling transcription will require the following parameters:  

Parameter | Example | Description
--- | --- | ---
projectId | `snip-it` | This is the project Id configured for Google Cloud which has the Google Speech API enabled
keyFilename | `/Path/To/keyfile.json` | This is the path to the keyfile that has been generated

The command to execute to include transcription:

```bash
snip-it --transcription=true --projectId=snip-it --keyFilename=/Path/To/keyfile.json
```

In addition to the segmented videos, a new spreadsheet will be created in `/output` that will contain the transcriptions.

---
_Source: https://npm.io/package/snip-it · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._