<commit_before># Jupyter devinstall tool
Utility designed to simplify the installation of a Jupyter/IPython development environment.

![Demo screen cast](/demo.gif)

## Installation
Make sure you have iojs (and npm, which is included) installed on your machine, then run:

```
npm install -g jupyter-devinstall
```

(you may need to prefix the line with `sudo `)

## Usage

```
jupyter-devinstall <githubUserName> <installDir> [--overwrite] [--reinstall] [--global]
```

Example for GitHub username `jdfreder` installed to the HOME directory:

```
jupyter-devinstall jdfreder ~/
```

## Notes

Part way through the tool will behave like a wizard, prompting you for input.  
  
The tool will ask you if you want to install locally, globally, or not at all:  
locally - pip install each repository  
globally - pip install each repository with the `-g` flag.  This may require sudo, which may have undesired side effects.  
not at all - doesn't pip install anything  
<commit_msg>Update the readme<commit_after># Jupyter devinstall tool
Utility designed to simplify the installation of a Jupyter/IPython development environment.

![Demo screen cast](/demo.gif)

## Installation
Make sure you have iojs (and npm, which is included) installed on your machine, then run:

```
npm install -g jupyter-devinstall
```

(you may need to prefix the line with `sudo `)

## Usage

```
Usage: jupyter-devinstall [options] <githubName> <installdir>

Options:

  -h, --help               output usage information
  -r, --reinstall          reinstall existing repositories, without recloning
  -o, --overwrite          overwrite existing directories
  -u, --upstream [string]  name of the upstream git remote [upstream]
  -g, --global             global install
  -n, --noInstall          don't install
  -s, --silent             don't prompt the user for anything
  -V, --version            output the version number
```

Example for GitHub username `jdfreder` installed to the HOME directory:

```
jupyter-devinstall jdfreder ~/
```

## Notes

If you have specified the `--silent` (`-s` for short) flag, part way through the 
tool will behave like a wizard, prompting you for input.  
  
The tool will ask you if you want to install locally, globally, or not at all:  
- locally - pip install each repository  
- globally - pip install each repository with the `-g` flag.  This may require sudo, which may have undesired side effects.  
- not at all - doesn't pip/npm install anything  
{'fraction_non_alphanumeric': 0.08781869688385269, 'fraction_numerical': 0.0, 'mean_word_length': 3.390763765541741, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, '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': '5115769', 'n_tokens_mistral': 753, 'n_tokens_neox': 703, 'n_words': 319}