From 776332d5fe6a5c2fdc1c400047db39833a9f52fe Mon Sep 17 00:00:00 2001 From: groegert Date: Thu, 20 May 2021 15:37:17 +0000 Subject: [PATCH] added some hints to ease the installation --- readme.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index c10cf58..5cef43d 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,10 @@ # Flaschengeist +This is the backend of the Flaschengeist. ## Installation ### Requirements - mysql or mariadb + - including development files libmariadb-dev - python 3.6+ ### Install python files pip3 install --user . @@ -30,9 +32,21 @@ Configuration is done within the a `flaschengeist.toml`file, you can copy the on 1. `~/.config/` 2. A custom path and set environment variable `FLASCHENGEIST_CONF` -Change at least the database parameters! +Uncomment and change at least all the database parameters! ### Database installation +The user needs to have full permissions to the database. +If not you need to create user and database manually do (or similar on Windows): + + ( + echo "CREATE DATABASE flaschengeist;" + echo "CREATE USER 'flaschengeist'@'localhost' IDENTIFIED BY 'flaschengeist';" + echo "GRANT ALL PRIVILEGES ON 'flaschengeist'.* TO 'flaschengeist'@'localhost';" + echo "FLUSH PRIVILEGES;" + ) | sudo mysql + +Then you can install the database tables and initial entries: + run_flaschengeist install ### Run @@ -41,6 +55,8 @@ or with debug messages: run_flaschengeist run --debug +This will run the backend on http://localhost:5000 + ## Tests $ pip install '.[test]' $ pytest @@ -55,7 +71,7 @@ Or with html output (open `htmlcov/index.html` in a browser): ## Development ### Code Style We enforce you to use PEP 8 code style with a line length of 120 as used by Black. -See also [Black Code Style](https://github.com/psf/black/blob/master/docs/the_black_code_style.md). +See also [Black Code Style](https://github.com/psf/black/blob/main/docs/the_black_code_style/current_style.md). #### Code formatting We use [Black](https://github.com/psf/black) as the code formatter.