Skip to content

Commit 751b938

Browse files
authored
[DOCS] Wheel building (#642)
Add wheel building instructions Co-authored-by: Florian <[email protected]>
1 parent bff4c39 commit 751b938

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

python/README.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
11
# Theengs Decoder
22

3-
## dependencies
4-
Building this module it requires scikit-build and cmake, if not already installed you will need to open a terminal and execute:
5-
```
6-
pip install scikit-build
7-
apt-get install cmake
8-
```
9-
10-
## installation
11-
12-
From a terminal cd to this folder and execute:
13-
```
14-
python setup.py install --user
15-
```
3+
## Installation
4+
5+
* Create a virtual environment
6+
`python3 -m venv theengs-venv`
7+
8+
* Activate the virtual environment
9+
`source theengs-venv/bin/activate`
10+
11+
* Install and upgrade pip
12+
`python3 -m pip install --upgrade pip`
13+
14+
* Install dependencies
15+
`pip3 install setuptools setuptools_scm cmake==3.25.0 wheel scikit-build ninja`
16+
17+
* Clone Theengs Decoder
18+
`git clone --recursive https://github.com/Theengs/decoder.git`
19+
20+
* cd to python folder inside the repository
21+
`cd decoder/python`
22+
23+
* Copy sources inside the build repository
24+
`cp -r ../src .`
25+
26+
* Build wheel
27+
`python3 setup.py bdist_wheel`
28+
29+
* Install
30+
`cd ..`
31+
`pip3 install python/dist/*.whl`
32+
33+
* Verify installation
34+
`python3 -c "from TheengsDecoder import decodeBLE; print('Successfully imported decodeBLE from PR_build.yml')"`
35+
36+
You should see:
37+
`Successfully imported decodeBLE from PR_build.yml`
1638

1739
## using
1840

0 commit comments

Comments
 (0)