Flaschengeist/flaschengeist
Flaschengeist
/
flaschengeist
7
0
Fork 0
Code Issues 20 Pull Requests Packages Projects Releases 2 Wiki Activity

docs(migrations): Some documentation ++
continuous-integration/woodpecker the build failed Details

This commit is contained in:
Ferdinand Thiessen 2021-12-21 22:53:30 +01:00
parent 88718676f8
commit 2b6472b655
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -3,14 +3,17 @@
This is the backend of the Flaschengeist. This is the backend of the Flaschengeist.
## Installation # Installation
### Requirements ## Main package
- `mysql` or `mariadb` ### System dependencies
- maybe `libmariadb` development files[1] - **python 3.7+**
- python 3.7+ - Database (MySQL / mariadb by default)
[1] By default Flaschengeist uses mysql as database backend, if you are on Windows Flaschengeist uses `PyMySQL`, but on By default Flaschengeist uses mysql as database backend,
Linux / Mac the faster `mysqlclient` is used, if it is not already installed installing from pypi requires the if you are on Windows Flaschengeist uses `PyMySQL`, which does not require any other system packages.
But on Linux / Mac / *nix the faster `mysqlclient` is used,
if it is not already installed, installing from PyPi requires the
development files for `libmariadb` to be present on your system. development files for `libmariadb` to be present on your system.
### Install python files ### Install python files
@ -22,16 +25,12 @@ or if you want to also run the tests:
pip3 install --user ".[ldap,test]" pip3 install --user ".[ldap,test]"
You will also need a MySQL driver, recommended drivers are You will also need a MySQL driver, by default one of this is installed:
- `mysqlclient` - `mysqlclient` (non Windows)
- `PyMySQL` - `PyMySQL` (on Windows)
`setup.py` will try to install a matching driver. #### Hint on MySQL driver on Windows:
If you want to use `mysqlclient` instead of `PyMySQL` (performance?) you have to follow [this guide](https://www.radishlogic.com/coding/python-3/installing-mysqldb-for-python-3-in-windows/)
#### Windows
Same as above, but if you want to use `mysqlclient` instead of `PyMySQL` (performance?) you have to follow this guide:
https://www.radishlogic.com/coding/python-3/installing-mysqldb-for-python-3-in-windows/
### Install database ### Install database
The user needs to have full permissions to the database. The user needs to have full permissions to the database.
@ -44,11 +43,12 @@ If not you need to create user and database manually do (or similar on Windows):
echo "FLUSH PRIVILEGES;" echo "FLUSH PRIVILEGES;"
) | sudo mysql ) | sudo mysql
Then you can install the database tables Then you can install the database tables, this will update all tables from core + all enabled plugins.
$ flaschengeist db upgrade heads $ flaschengeist db upgrade heads
Or to only upgrade one plugin: ## Plugins
To only upgrade one plugin:
$ flaschengeist db upgrade events@head $ flaschengeist db upgrade events@head