Skip to content

README Adjustment #294

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

Merged
merged 6 commits into from
Mar 25, 2022
Merged

README Adjustment #294

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
52a7995
Add install instructions to the README for Python and dependencies
TwistedTwigleg Mar 22, 2022
927afa3
Updated to incldue specific instructions for installing Python3
TwistedTwigleg Mar 22, 2022
fc69c91
fix a indent
xiazhvera Mar 22, 2022
56a97b5
Added PREREQUISITES.md and removed links to C++ repository in install…
TwistedTwigleg Mar 22, 2022
02cc1ae
Fixed link to brew install instructions being incorrect
TwistedTwigleg Mar 22, 2022
d4bbc5f
Merge branch 'main' into ReadMeAdjustment
TwistedTwigleg Mar 25, 2022
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ to Python by the `awscrt` package ([PyPI](https://pypi.org/project/awscrt/)) ([G
## Installation

### Minimum Requirements
* Python 3.6+
* Python 3.6+
* On Windows, download a Python installer from the official Python website: [Python Website](https://www.python.org/downloads/)
* On MacOS, install Brew ([Brew install instructions](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/PREREQUISITES.md#xcode-command-line-tools-using-brew)) and then run `brew install python`.
* On Linux, install Python using `sudo apt-get install python3` on Ubuntu, `sudo pacman -S python3` for Arch Linux, or `sudo yum install python3` for Linux distros that support `yum`.

### Install from PyPI
```
Expand All @@ -50,14 +53,12 @@ python3 -m pip install ./aws-iot-device-sdk-python-v2
`awsiotsdk` depends on [awscrt](https://github.com/awslabs/aws-crt-python), which makes use of C extensions. Precompiled wheels are downloaded when installing on major platforms (Mac, Windows, Linux, Raspberry Pi OS). If wheels are unavailable for your platform, your machine must compile some C libraries. If you encounter issues, be sure the following are installed and try again:

* CMake 3.1+
* Follow the CMake install steps here: [C++ Install Prerequests](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/PREREQUISITES.md#cmake-31))
* You may also need to install GCC, Clang, or MSVC to compile C code. You can find instructions to install a C compiler here: [C++ Install Prerequests](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/PREREQUISITES.md#cmake-31))
* Python headers and libs

```
sudo apt-get update
sudo apt-get install cmake
sudo apt-get install python3-dev
```

* To install on Linux run `sudo apt-get install python3-dev` for Ubuntu, `sudo pacman -S python3-dev` for Arch Linux, or `sudo yum install python3-devel` for Linux distros that support `yum`.
* For MacOS, Python headers and libraries should be installed automatically if using `brew`. You can find them in the `include` folder in your Pyhton install directory (For example `Cellar/python3/3.3.0/Frameworks/Python.framework/Versions/3.3/include/python3.3/`).
* Python headers and libraries should be automatically installed on Windows as part of running the Windows installation. You can find them in the `include` folder in your Python install directory (For example `C:\Python\include` and `C:\Python\libs`).

## Mac-Only TLS Behavior

Expand Down