diff --git a/docs/bare-metal-installation.md b/docs/bare-metal-installation.md index 911d52d7e5719652c4e13846e138ebb0213eb167..c3a13ddd2c03d96084f54c9f74d53cf7769bcb52 100644 --- a/docs/bare-metal-installation.md +++ b/docs/bare-metal-installation.md @@ -2,18 +2,18 @@ <!-- TOC --> -- [Install for Development](#install-for-development) - - [Prerequisites](#prerequisites) - - [Preparation](#preparation) - - [Setting up the database](#setting-up-the-database) - - [Configuration](#configuration) - - [Running Engine](#running-engine) - - [Starting dependencies](#starting-dependencies) - - [Daemonized Engine](#daemonized-engine) - - [Running with Systemd](#running-with-systemd) - - [Running with Supervisor](#running-with-supervisor) - - [Logging](#logging) - - [Read more](#read-more) +1. [Install for Development](#install-for-development) + 1. [Prerequisites](#prerequisites) + 2. [Preparation](#preparation) + 1. [Setting up the database](#setting-up-the-database) + 3. [Configuration](#configuration) + 4. [Running Engine](#running-engine) + 1. [Starting dependencies](#starting-dependencies) + 5. [Daemonized Engine](#daemonized-engine) + 1. [Running with Systemd](#running-with-systemd) + 2. [Running with Supervisor](#running-with-supervisor) + 6. [Logging](#logging) + 7. [Read more](#read-more) <!-- /TOC --> @@ -47,6 +47,7 @@ If you are developing engine you also might want the projects `steering`, `dashb Install dependencies: ```shell apt install \ + python3-wheel \ python3-flask \ python3-flask-sqlalchemy \ python3-http-parser \ diff --git a/docs/developer-guide.md b/docs/developer-guide.md index 00c5441e0df53b04acc897e5d5a16a440d88e8e8..9b3132feb811d89379bf8c994ce958eefefcbca4 100644 --- a/docs/developer-guide.md +++ b/docs/developer-guide.md @@ -5,7 +5,7 @@ This page gives insights on extending Aura Engine internals or through the API. <!-- TOC --> 1. [Aura Engine Development Guide](#aura-engine-development-guide) - 1. [AURA Components](#aura-componentes) + 1. [AURA Components](#aura-components) 2. [Engine Components](#engine-components) 3. [Running for Development](#running-for-development) 4. [Testing](#testing) @@ -53,29 +53,23 @@ Ensure you have following other projects up and running: The following steps expect you having done the bases configuration and set up a database as outlined in the [Native Installation](https://gitlab.servus.at/aura/engine/-/blob/master/docs/bare-metal-installation.md) document. -If you don't have already, you'll need to create an virtual environment: +Start Liquidsoap which is part of Engine Core: ```shell -~/code/aura/engine$ python3.8 -m venv python -``` - -Then you can start the engine. The following command includes the activation of your virtual environment, which you have created during the installation step (`source python/bin/activate`): - -```shell -~/code/aura/engine$ ./run.sh dev +~/code/aura/engine-core$ ./run.sh ``` -Now start Liquidsoap which is part of Engine Core: +Now run the Engine: ```shell -~/code/aura/engine-core$ ./run.sh +~/code/aura/engine$ ./run.sh ``` If your IDE of choice is *Visual Studio Code*, then there are launch settings provided in `.vscode/launch.json`. ## Testing -Test cases are located in `./tests`. The test command expects a virtual environment in `./python` which gets activated automatically as soon you run the tests with +Test cases are located in `./tests` are executed by running: ```shell ~/code/aura/engine$ ./run.sh test diff --git a/run.sh b/run.sh index b5323c6fee99f7acdec066da17caeff68eeb973a..be2c34287df86f65a5616cfc56e559aa7d882e5c 100755 --- a/run.sh +++ b/run.sh @@ -41,12 +41,11 @@ echo "[ Using $(python3 -V) ]" if [[ $docker == "false" ]]; then - ### Runs Engine in development mode (Virtualenv) ### + ### Runs Engine in development mode ### if [[ $mode == "dev" ]]; then - source python/bin/activate - echo "Running Engine in Python Environment ($(python3 -V))" - python run.py + echo "Running Engine (Development)" + python3 run.py fi ### Runs Engine ### @@ -58,9 +57,9 @@ if [[ $docker == "false" ]]; then ### Runs Tests ### if [[ $mode == "test" ]]; then - source python/bin/activate - echo "Running Engine Tests in Python Environment ($(python3 -V))" - python -m unittest discover tests + # source python/bin/activate + echo "Running Engine Tests" + python3 -m unittest discover tests fi ### CAUTION: This deletes everything in your database ###