feat(examples): add example playing sointu tracks from Python (#108)

* Added Python code example.
* Added pyinstaller build.
* Clarified debugging steps in README.md.
* Added linux implementation.
* Cosmetics.
* Updated README with correct steps.
This commit is contained in:
Alexander Kraus
2023-10-11 08:37:00 +02:00
committed by GitHub
parent f5eeabe5f3
commit 94589eb2eb
9 changed files with 619 additions and 0 deletions

View File

@ -0,0 +1,18 @@
# Embed Sointu in Python
This is an example for embedding Sointu into Python code.
# Configure the track
Edit the `track` variable in `build.py` according to your needs.
# Build
* Install Python 3.11 and poetry.
* Download nasm and golang; place both of them in your system `PATH`.
* Enable cgo by downloading a gcc and placing it into your system `PATH`.
* Get the dependencies with `poetry install`.
* Run the player using `poetry run python -m sointu_python`.
* Pack everything into an executable using `poetry run pyinstaller sointu_python/sointu_python.spec`. The executable will be built in the `dist` subfolder.
# Rebuild after changes
* Rebuild the example track bindings with `poetry build`.
* Update the bindings module with `poetry install`.
* Proceed iteration.