Tag for 1.0.0b2 release

Azure · Sep 2, 2017 · 9b6fae6 · 9b6fae6
1 parent 4bbba17
commit 9b6fae6
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 
+## [1.0.0b2] - 2017-09-01
 ### Added
 - `upload` from `stdin` to page blob support. Optional
 `--stdin-as-page-blob-size` parameter added. Please see current limitations
@@ -11,8 +12,9 @@ doc for more information.
 
 ### Changed
 - AppVeyor integration
-- PyPI releases automatically generated for tags
-- PyInstaller-based releases uploaded to GitHub for Windows and Linux
+- Automated PyPI releases generated for tags
+- Automated PyInstaller-based releases uploaded to GitHub for Windows and Linux
+- Automated Windows Docker image build
 
 ### Fixed
 - YAML config merge with CLI options when YAML options not present
@@ -248,7 +250,8 @@ usage documentation carefully when upgrading from 0.12.1.
   `--no-skiponmatch`.
 - 0.8.2: performance regression fixes
 
-[Unreleased]: https://github.com/Azure/blobxfer/compare/1.0.0b1...HEAD
+[Unreleased]: https://github.com/Azure/blobxfer/compare/1.0.0b2...HEAD
+[1.0.0b2]: https://github.com/Azure/blobxfer/compare/1.0.0b1...1.0.0b2
 [1.0.0b1]: https://github.com/Azure/blobxfer/compare/1.0.0a5...1.0.0b1
 [1.0.0a5]: https://github.com/Azure/blobxfer/compare/1.0.0a4...1.0.0a5
 [1.0.0a4]: https://github.com/Azure/blobxfer/compare/0.12.1...1.0.0a4

diff --git a/README.md b/README.md
@@ -43,10 +43,15 @@ copies for Block blobs)
 * File logging support
 
 ## Installation
-`blobxfer` is on [PyPI](https://pypi.python.org/pypi/blobxfer) and on
-[Docker Hub](https://hub.docker.com/r/alfpark/blobxfer/). Please refer to
-the [installation guide](https://github.com/Azure/blobxfer/blob/master/docs/01-installation.md)
-on how to install `blobxfer`.
+There are three ways to install `blobxfer`:
+* `blobxfer` Python package from [PyPI](https://pypi.python.org/pypi/blobxfer)
+* Pre-built binaries available under [Releases](https://github.com/Azure/blobxfer/releases)
+* Docker images are available for both Linux and Windows platforms on
+[Docker Hub](https://hub.docker.com/r/alfpark/blobxfer/)
+
+Please refer to the
+[installation guide](https://github.com/Azure/blobxfer/blob/master/docs/01-installation.md)
+for more information on how to install `blobxfer`.
 
 ## Documentation
 Please refer to the [`blobxfer` documentation](https://github.com/Azure/blobxfer/blob/master/docs)

diff --git a/blobxfer/version.py b/blobxfer/version.py
@@ -22,4 +22,4 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 # DEALINGS IN THE SOFTWARE.
 
-__version__ = '1.0.0b1'
+__version__ = '1.0.0b2'
diff --git a/docs/01-installation.md b/docs/01-installation.md
@@ -1,78 +1,118 @@
 # blobxfer Installation
+There are multiple available options for installing `blobxfer`. If you
+only require the CLI functionality, then you can install via one of
+three methods:
+* [Python package from PyPI](#pypi) (i.e., `pip install`)
+* [Pre-built binary](#binary)
+* [Docker image](#docker)
+
+If you require the `blobxfer` data movement library, then you will
+need to install the [Python package from PyPI](#pypi).
+
+## <a name="pypi"></a>Python Package from PyPI
 `blobxfer` is a pure Python package, however, some dependencies require a C
 compiler and supporting libraries if there is no binary wheel for that
 dependency and your platform. Please follow the pre-requisites section first
-prior to invoking installation via `pip`. Alternatively, you can use the
-[blobxfer Docker image](https://hub.docker.com/r/alfpark/blobxfer/).
+prior to invoking installation via `pip`.
 
-## Pre-requisites
+### Pre-requisites
 `blobxfer` has dependencies which require a C compiler if your platform does
 not have pre-made binary wheels for these dependencies. Please follow the
-instructions below for your platform.
+instructions below for your platform. You will need to run the following
+commands via `sudo` or as root.
 
-### Ubuntu
+#### Ubuntu
 ```shell
-apt-get update
 # for Python3 (recommended)
+apt-get update
 apt-get install -y build-essential libssl-dev libffi-dev python3-dev python3-pip
+
 # for Python2
+apt-get update
 apt-get install -y build-essential libssl-dev libffi-dev python-dev python-pip
 ```
 
-### CentOS/RHEL
+#### CentOS/RHEL
 ```shell
+# for Python3 (recommended)
+yum install -y epel-release
+yum install -y python34 python34-devel gcc openssl-devel libffi-devel
+curl -fSsL https://bootstrap.pypa.io/get-pip.py | python3
+
 # for Python2
 yum install -y gcc openssl-dev libffi-devel python-devel
 curl -fSsL https://bootstrap.pypa.io/get-pip.py | python
 ```
 
-### SLES/OpenSUSE
+#### SLES/OpenSUSE
 ```shell
+# for Python3 (recommended)
 zypper ref
+zypper -n in gcc libopenssl-devel libffi48-devel python3-devel
+curl -fSsL https://bootstrap.pypa.io/get-pip.py | python3
+
 # for Python2
+zypper ref
 zypper -n in gcc libopenssl-devel libffi48-devel python-devel
 curl -fSsL https://bootstrap.pypa.io/get-pip.py | python
 ```
 
-### Mac OS X
+#### Mac OS X
 Python 2.7 should come pre-installed. However, if you want to install
 `blobxfer` for Python 3.5+ (recommended), please follow the steps outlined on
 [this guide](http://docs.python-guide.org/en/latest/starting/install/osx/)
 to ensure that you have the latest version of Python, a compiler and pip.
 
-### Windows
+#### Windows
 Please install at least Python 3.5 or later to avoid requiring a
 compiler. If you must use Python 2.7, you can download the necessary
 development headers and compiler [from Microsoft](http://aka.ms/vcpython27).
 
-### Windows Subsystem for Linux
+#### Windows Subsystem for Linux
 Please follow the same instructions for the Linux distribution installed.
 
-## Installation via `pip`
-[blobxfer](https://pypi.python.org/pypi/blobxfer) is on PyPI and can be
-installed via:
+### Installation via `pip`
+After the pre-requisite steps have been completed then install the
+[blobxfer](https://pypi.python.org/pypi/blobxfer) Python package:
 
 ```shell
-# for Python3 (recommended)
+# for Python3
 pip3 install blobxfer
+
 # for Python2
 pip install blobxfer
 ```
 
-`blobxfer` is compatible with Python 2.7 and 3.3+. To install for Python 3
+`blobxfer` is compatible with Python 2.7 and 3.4+. To install for Python 3
 (which is recommended), some distributions may use `pip3` instead of `pip`.
 Installing into a virtual environment or your user area via `--user`
 is recommended to avoid installation issues and conflicts with system-wide
 Python packages.
 
-## Installation via Docker
-[blobxfer](https://hub.docker.com/r/alfpark/blobxfer/) is also on Docker
-Hub and can be retrieved via:
+## <a name="binary"></a>Pre-built Binary
+Download an appropriate [Release](https://github.com/Azure/blobxfer/releases)
+binary for your operating system. Pre-built binaries are not available
+for all platforms and architectures at this time.
+
+Note that for the Linux pre-built binary, it may not work on all
+distributions. If this is the case, please pick an alternate installation
+method.
+
+## <a name="docker"></a>Docker Image
+[blobxfer](https://hub.docker.com/r/alfpark/blobxfer/) is available on
+Docker Hub and can be retrieved with:
 
 ```shell
+# Linux
 docker pull alfpark/blobxfer
+
+# Windows
+docker pull alfpark/blobxfer:latest-windows
 ```
 
+Please note that when invoking the Docker image, you will need to ensure
+proper mapping of host to container mount points.
+
 ## Troubleshooting
 #### `azure.storage` dependency not found
 If you get an error such as `ImportError: No module named storage` or that