Skip to content
Merged
Changes from all commits
Commits
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
48 changes: 35 additions & 13 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,40 @@
# Theengs Decoder

## dependencies
Building this module it requires scikit-build and cmake, if not already installed you will need to open a terminal and execute:
```
pip install scikit-build
apt-get install cmake
```

## installation

From a terminal cd to this folder and execute:
```
python setup.py install --user
```
## Installation

* Create a virtual environment
`python3 -m venv theengs-venv`

* Activate the virtual environment
`source theengs-venv/bin/activate`

* Install and upgrade pip
`python3 -m pip install --upgrade pip`

* Install dependencies
`pip3 install setuptools setuptools_scm cmake==3.25.0 wheel scikit-build ninja`

* Clone Theengs Decoder
`git clone --recursive https://github.com/Theengs/decoder.git`

* cd to python folder inside the repository
`cd decoder/python`

* Copy sources inside the build repository
`cp -r ../src .`

* Build wheel
`python3 setup.py bdist_wheel`

* Install
`cd ..`
`pip3 install python/dist/*.whl`

* Verify installation
`python3 -c "from TheengsDecoder import decodeBLE; print('Successfully imported decodeBLE from PR_build.yml')"`

You should see:
`Successfully imported decodeBLE from PR_build.yml`

## using

Expand Down