Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Working pipinstall #885

Merged
merged 2 commits into from
Oct 21, 2016
Merged

Working pipinstall #885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89b485c
Update Python setup instructions for Windows
mregen Oct 19, 2016
ebee9b9
Expand Pip instructions
dominicbetts Oct 21, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion doc/get_started/python-devbox-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This document describes how to prepare your development environment to use the *

- [Setup your development environment](#devenv)
- [Build the samples on Linux](#linux)
- [Install on Windows using PyPI wheels](#windows-wheels)
- [Build the samples on Windows using nuget packages](#windows)
- [Build the samples on Windows using cmake and boost libraries](#windows-cmake)
- [Sample applications](#samplecode)
Expand Down Expand Up @@ -40,14 +41,28 @@ The Python iothub_client supports python versions 2.7.x, 3.4.x or 3.5.x. Know th
1. On some small footprint Linux devices, like a *Raspberry Pi* using Raspbian OS, the following build error may occur: `virtual memory exhausted: Cannot allocate memory`. In such a case please try to increase the swap file size on your platform and retry the build. (If swap increase did not work consider running build.sh using --skip-unittests --use-websockets parameters)
2. CentOS7: Only Python 2.7 is supported due to a missing boost-python3 library package

<a name="windows-wheels"/>
## Install the Python iothub_client module on Windows from [PyPI]

The following instructions outline how you can install the **iothub\_client** module in Windows from [PyPi] using the **iothub\_client** package:

1. Open a command-prompt window.
2. Install the **iothub\_client** package with the following command: `pip install iothub-client`
3. Now Python is ready to run the sample applications.
Please follow instructions in [Sample applications](#samplecode) to run the Python samples.

> Note: If it is not already installed, you need to install the [Visual C++ Redistributable for Visual Studio 2015][lnk-c-redist].

> Note: If Pip cannot install the package for the specific version of Python installed on your machine, use one of the following options to build the **iothub_client** module.

<a name="windows"/>
## Build the Python iothub_client module on Windows using Nuget packages (recommended)

The following instructions outline how you can build the libraries in Windows:

1. Open a Visual Studio 2015 x86 Native Tools command prompt and navigate to the folder **python/build_all/windows** in your local copy of the repository.
2. Run the script `build.cmd` in the **python\\build_all\\windows** directory.
3. As a result, the `iothub_client.pyd` Python extension module is copied to the **python/device/samples** folder. Please follow instructions in [Sample applications](#samplecode) to run the Python samples.
3. As a result, the `iothub_client.pyd` Python extension module is copied to the **python/device/samples** folder. Follow the instructions in [Sample applications](#samplecode) to run the Python IoT Hub samples.
4. In order to run the samples with a different Python version (e.g. 32bit vs. 64bit or 2.7 vs. 3.4) please rebuild the `iothub_client.pyd` extension.

<a name="windows-cmake"/>
Expand Down Expand Up @@ -84,7 +99,9 @@ To use the iothub_client extension for native code debugging with [Python Tools
This repository contains various Python sample applications that illustrate how to use the Microsoft Azure IoT SDK for Python. To learn how to run a sample application that sends messages to an IoT hub, see [Getting started - running a Python sample application][getstarted].

[python-2.7 or python-3.5]: https://www.python.org/downloads/
[PyPI]: https://pypi.python.org/pypi/iothub-client/
[Python Tools for Visual Studio]: https://www.visualstudio.com/en-us/features/python-vs.aspx
[setup-devbox]: https://github.com/Azure/azure-iot-sdks/blob/master/c/doc/devbox_setup.md
[getstarted]: python-run-sample.md
[boost-zip]: http://www.boost.org/users/history/version_1_60_0.html
[lnk-c-redist]: https://www.microsoft.com/download/details.aspx?id=48145
2 changes: 2 additions & 0 deletions doc/get_started/python-run-sample.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ You should have the following items ready before beginning the process:

- Make sure desktop is ready as per instructions given on [Prepare your development environment][lnk-python-devbox-setup].

> Note: On Windows, you can install the **iothub-client** module package using Pip as described in [Prepare your development environment][lnk-python-devbox-setup].

<a name="Run"></a>
# Step 3: Run the sample

Expand Down