Skip to content

Commit

Permalink
Update Readme and Setup.py
Browse files Browse the repository at this point in the history
Update the installation instructions and add Python 3 to the setup.py
  • Loading branch information
ELC committed Apr 6, 2018
1 parent bd88530 commit 4278d8a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
@@ -1,17 +1,24 @@
# nbflow
# NBFlow

[![Build Status](https://travis-ci.org/jhamrick/nbflow.svg?branch=master)](https://travis-ci.org/jhamrick/nbflow)

A tool that supports one-button reproducible workflows with the Jupyter Notebook and Scons.
**Note: this currently requires Python 2 (because Scons does not yet support Python 3),
and currently only supports Python kernels.**
A tool that supports one-button reproducible workflows with the Jupyter Notebook and Scons. **Note: this currently only supports Python kernels.**

> **UPDATE: Scons >= 3.0.0 now supports Python 3 so Python 2 isn't needed anymore!** Now Nbflow and Scons are both Python 2 and 3 compatible so you can choose whichever you want.

## Installation

To install, run:

Linux:
```
pip3 install git+git://github.com/jhamrick/nbflow.git
```

Windows:
```
pip2 install git+git://github.com/jhamrick/nbflow.git
pip install git+git://github.com/jhamrick/nbflow.git
```

## Usage
Expand Down
2 changes: 2 additions & 0 deletions setup.py
Expand Up @@ -40,6 +40,8 @@
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
],
packages=['nbflow'],
scripts=['scripts/nbflow'],
Expand Down

0 comments on commit 4278d8a

Please sign in to comment.