diff --git a/README.md b/README.md index a637b041..925ae632 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,95 @@ -#[Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/) +# [Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/) -###BY[ JIMMY SONG](https://github.com/jimmysong) +### BY[ JIMMY SONG](https://github.com/jimmysong) -#####[O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/) +##### [O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/) -# LICENSE +## LICENSE Repository for the book to be published by O'Reilly. This book will be licensed under [CC-BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode) once the book is published. -##Setting Up - +## Setting Up To get the most out of this book, you’ll want to create an environment where you can run the example code and do the exercises. Here are the steps required to set everything up: -###1. Install Python 3.5 or higher on your machine: +### 1. Install Python 3.5 or higher on your machine: -Windows: +#### Windows: [https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe ](https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe ) -macOS: +#### MacOS: [https://www.python.org/ftp/python/3.6.2/python-3.6.2-macosx10.6.pkg](https://www.python.org/ftp/python/3.6.2/python-3.6.2-macosx10.6.pkg) -Linux -#####See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled) +#### Linux: +###### See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled) -###2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py). +### 2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py). -###3. Run this script using Python 3: +### 3. Run this script using Python 3: -`$ python3 get-pip.py` +$ `python3 get-pip.py` -###4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads). +### 4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads). -###5. Download the source code for this book: +### 5. Download the source code for this book: -`$ git clone https://github.com/jimmysong/programmingbitcoin` -`$ cd programmingbitcoin` - -###6. Install virtualenv: +$ `git clone https://github.com/jimmysong/programmingbitcoin` + +$`cd programmingbitcoin` +### 6. Install virtualenv: + +$ `python3 -m pip install virtualenv` + +### 7. Install the requirements: + +Linux/MacOS: + +$ `virtualenv -p python3 .venv` -`$ pip install virtualenv` +$ `. .venv/bin/activate` + +$ `(.venv) $ pip install -r requirements.txt` + +Windows: + +$ `C:\programmingbitcoin> virtualenv -p` + +$ `C:\PathToYourPythonInstallation\Python.exe .venv` + +$ `C:\programmingbitcoin> .venv\Scripts\activate.bat` + +$ `C:\programmingbitcoin> pip install -r requirements.txt` -###7. Install the requirements: +### 8. Run Jupyter Notebook: -Linux/macOS +$ `(.venv) $ jupyter notebook` -`$ virtualenv -p python3 .venv` -`$ . .venv/bin/activate` -`(.venv) $ pip install -r requirements.txt` +##### Example output: -Windows +--- -`C:\programmingbitcoin> virtualenv -p` -`C:\PathToYourPythonInstallation\Python.exe .venv` -`C:\programmingbitcoin> .venv\Scripts\activate.bat` -`C:\programmingbitcoin> pip install -r requirements.txt` -###8. Run Jupyter Notebook: +``` +[I 15:04:41.484 NotebookApp] The port 8888 is already in use, trying another port. +[I 15:04:41.485 NotebookApp] Serving notebooks from local directory: /Users/git/programmingbitcoin +[I 15:04:41.485 NotebookApp] Jupyter Notebook 6.4.5 is running at: +[I 15:04:41.485 NotebookApp] http://localhost:8889/?token=b89cafc45270f550caf6ab53184e307be942ed75e51540e8 +[I 15:04:41.485 NotebookApp] or http://127.0.0.1:8889/?token=b89cafc45270f550caf6ab53184e307be942ed75e51540e8 +[I 15:04:41.485 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation). +[C 15:04:41.500 NotebookApp] -`(.venv) $ jupyter notebook` -`[I 11:13:23.061 NotebookApp] Serving notebooks from local directory: - /home/jimmy/programmingbitcoin` - `[I 11:13:23.061 NotebookApp] The Jupyter Notebook is running at: - [I 11:13:23.061 NotebookApp] http://localhost:8888/?token= - f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7` - `[I 11:13:23.061 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).` - `[C 11:13:23.065 NotebookApp]` - `Copy/paste this URL into your browser when you connect for` - `the first time, to login with a token:` - `http://localhost:8888/?token=f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7` + To access the notebook, open this file in a browser: + file:///Users/git/Library/Jupyter/runtime/nbserver-15734-open.html + Or copy and paste one of these URLs: + http://localhost:8888/?token=f0f7fee38102213899079ad0c7086b84a8a2c654bc61937c + or http://127.0.0.1:8888/?token=f0f7fee38102213899079ad0c7086b84a8a2c654bc61937c +``` +--- You should have a browser open up automatically, as shown in [Figure P-1](https://raw.githubusercontent.com/jimmysong/programmingbitcoin/master/images/prbc_0001.png).