Skip to content

Commit 16d9937

Browse files
authored
ENGDESK-4420: Update README to include non-x86 installation instructions (#26)
I've also updated the package to use the README.md as the package long_description rather than a separate file.
1 parent 90e5276 commit 16d9937

File tree

4 files changed

+23
-30
lines changed

4 files changed

+23
-30
lines changed

LONG_DESCRIPTION.rst

-27
This file was deleted.

MANIFEST.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
include .coveragerc .flake8 CHANGELOG.md LICENSE LONG_DESCRIPTION.rst README.md VERSION pytest.ini tox.ini
1+
include .coveragerc .flake8 CHANGELOG.md LICENSE README.md VERSION pytest.ini tox.ini
22
recursive-include tests *.py

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,30 @@ Install from source with:
3131

3232
python setup.py install
3333

34+
### Non x86/x86_64 Processors
35+
36+
The `telnyx` package is distributed as a wheel (pre-compiled package) for easy
37+
installation. The wheel is built only for x86/x86_64 processors. When
38+
installing the package on a different architecture, like ARM, the `pip`
39+
installer will fall back to installing from source. As a result, you will
40+
need to ensure you have the additional dependencies installed. This will
41+
affect you if you're using a Raspberry Pi, for example.
42+
43+
For ARM specifically, as an alternative to a source install, you could look
44+
into using https://www.piwheels.org/ for ARM compiled wheels.
45+
3446
### Requirements
3547

3648
- Python 2.7 or 3.5+ (PyPy supported)
3749

50+
#### Additional Requirements for Source Install
51+
52+
- build-essentials (gcc, make)
53+
- python-dev
54+
- libffi-dev
55+
56+
_These packages are listed as they are named on Ubuntu._
57+
3858
## Usage
3959

4060
The library needs to be configured with your account's API Key which is

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ def run_tests(self):
2525

2626
os.chdir(here)
2727

28-
with open(os.path.join(here, "LONG_DESCRIPTION.rst"), encoding="utf-8") as f:
28+
with open(os.path.join(here, "README.md"), encoding="utf-8") as f:
2929
long_description = f.read()
3030

3131
setup(
3232
name="telnyx",
3333
version="1.0.0b4",
3434
description="Python bindings for the Telnyx API",
3535
long_description=long_description,
36-
long_description_content_type="text/x-rst",
36+
long_description_content_type="text/markdown",
3737
author="Telnyx",
3838
author_email="[email protected]",
3939
url="https://github.com/team-telnyx/telnyx-python",

0 commit comments

Comments
 (0)