Compare commits
No commits in common. "b76022ec87953459547c0dfc07a667ebf3a9621b" and "471bfd534da4387e5919103766375a2f01e62584" have entirely different histories.
b76022ec87
...
471bfd534d
|
@ -9,7 +9,7 @@ from flaschengeist import _module_path, logger
|
||||||
|
|
||||||
|
|
||||||
# Default config:
|
# Default config:
|
||||||
config = {"DATABASE": {"engine": "mysql", "port": 3306}}
|
config = {"DATABASE": {"port": 3306}}
|
||||||
|
|
||||||
|
|
||||||
def update_dict(d, u):
|
def update_dict(d, u):
|
||||||
|
@ -65,35 +65,17 @@ def configure_app(app, test_config=None):
|
||||||
else:
|
else:
|
||||||
app.config["SECRET_KEY"] = config["FLASCHENGEIST"]["secret_key"]
|
app.config["SECRET_KEY"] = config["FLASCHENGEIST"]["secret_key"]
|
||||||
|
|
||||||
if test_config is not None:
|
if test_config is None:
|
||||||
config["DATABASE"]["engine"] = "sqlite"
|
app.config["SQLALCHEMY_DATABASE_URI"] = "mysql{driver}://{user}:{passwd}@{host}:{port}/{database}".format(
|
||||||
|
driver="+pymysql" if os.name == "nt" else "",
|
||||||
if config["DATABASE"]["engine"] == "mysql":
|
|
||||||
engine = "mysql"
|
|
||||||
try:
|
|
||||||
# Try mysqlclient first
|
|
||||||
from MySQLdb import _mysql
|
|
||||||
except ModuleNotFoundError:
|
|
||||||
engine += "+pymysql"
|
|
||||||
options = "?charset=utf8mb4"
|
|
||||||
elif config["DATABASE"]["engine"] == "postgres":
|
|
||||||
engine = "postgresql+psycopg2"
|
|
||||||
options = "?client_encoding=utf8"
|
|
||||||
elif config["DATABASE"]["engine"] == "sqlite":
|
|
||||||
engine = "sqlite"
|
|
||||||
options = ""
|
|
||||||
host = ""
|
|
||||||
else:
|
|
||||||
logger.error(f"Invalid database engine configured. >{config['DATABASE']['engine']}< is unknown")
|
|
||||||
raise Exception
|
|
||||||
if config["DATABASE"]["engine"] in ["mysql", "postgresql"]:
|
|
||||||
host = "{user}:{password}@{host}:{port}".format(
|
|
||||||
user=config["DATABASE"]["user"],
|
user=config["DATABASE"]["user"],
|
||||||
password=config["DATABASE"]["password"],
|
passwd=config["DATABASE"]["password"],
|
||||||
host=config["DATABASE"]["host"],
|
host=config["DATABASE"]["host"],
|
||||||
|
database=config["DATABASE"]["database"],
|
||||||
port=config["DATABASE"]["port"],
|
port=config["DATABASE"]["port"],
|
||||||
)
|
)
|
||||||
app.config["SQLALCHEMY_DATABASE_URI"] = f"{engine}://{host}/{config['DATABASE']['database']}{options}"
|
else:
|
||||||
|
app.config["SQLALCHEMY_DATABASE_URI"] = f"sqlite+pysqlite://{config['DATABASE']['file_path']}"
|
||||||
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
|
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
|
||||||
|
|
||||||
if "root" in config["FLASCHENGEIST"]:
|
if "root" in config["FLASCHENGEIST"]:
|
||||||
|
|
|
@ -20,7 +20,6 @@ secret_key = "V3ryS3cr3t"
|
||||||
level = "WARNING"
|
level = "WARNING"
|
||||||
|
|
||||||
[DATABASE]
|
[DATABASE]
|
||||||
# engine = "mysql" (default)
|
|
||||||
# user = "user"
|
# user = "user"
|
||||||
# host = "127.0.0.1"
|
# host = "127.0.0.1"
|
||||||
# password = "password"
|
# password = "password"
|
||||||
|
|
|
@ -2,7 +2,7 @@ import sys
|
||||||
import datetime
|
import datetime
|
||||||
|
|
||||||
from sqlalchemy import BigInteger
|
from sqlalchemy import BigInteger
|
||||||
from sqlalchemy.dialects import mysql, sqlite
|
from sqlalchemy.dialects import mysql
|
||||||
from sqlalchemy.types import DateTime, TypeDecorator
|
from sqlalchemy.types import DateTime, TypeDecorator
|
||||||
|
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ class ModelSerializeMixin:
|
||||||
class Serial(TypeDecorator):
|
class Serial(TypeDecorator):
|
||||||
"""Same as MariaDB Serial used for IDs"""
|
"""Same as MariaDB Serial used for IDs"""
|
||||||
|
|
||||||
impl = BigInteger().with_variant(mysql.BIGINT(unsigned=True), "mysql").with_variant(sqlite.INTEGER, "sqlite")
|
impl = BigInteger().with_variant(mysql.BIGINT(unsigned=True), "mysql")
|
||||||
|
|
||||||
|
|
||||||
class UtcDateTime(TypeDecorator):
|
class UtcDateTime(TypeDecorator):
|
||||||
|
|
114
readme.md
114
readme.md
|
@ -1,16 +1,9 @@
|
||||||
# Flaschengeist
|
# Flaschengeist
|
||||||
This is the backend of the Flaschengeist.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
### Requirements
|
### Requirements
|
||||||
- `mysql` or `mariadb`
|
- mysql or mariadb
|
||||||
- maybe `libmariadb` development files[1]
|
- python 3.6+
|
||||||
- python 3.7+
|
|
||||||
|
|
||||||
[1] By default Flaschengeist uses mysql as database backend, if you are on Windows Flaschengeist uses `PyMySQL`, but on
|
|
||||||
Linux / Mac 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.
|
|
||||||
|
|
||||||
### Install python files
|
### Install python files
|
||||||
pip3 install --user .
|
pip3 install --user .
|
||||||
or with ldap support
|
or with ldap support
|
||||||
|
@ -37,21 +30,9 @@ Configuration is done within the a `flaschengeist.toml`file, you can copy the on
|
||||||
1. `~/.config/`
|
1. `~/.config/`
|
||||||
2. A custom path and set environment variable `FLASCHENGEIST_CONF`
|
2. A custom path and set environment variable `FLASCHENGEIST_CONF`
|
||||||
|
|
||||||
Uncomment and change at least all the database parameters!
|
Change at least the database parameters!
|
||||||
|
|
||||||
### Database installation
|
### 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_flaschengeist install
|
||||||
|
|
||||||
### Run
|
### Run
|
||||||
|
@ -60,8 +41,6 @@ or with debug messages:
|
||||||
|
|
||||||
run_flaschengeist run --debug
|
run_flaschengeist run --debug
|
||||||
|
|
||||||
This will run the backend on http://localhost:5000
|
|
||||||
|
|
||||||
## Tests
|
## Tests
|
||||||
$ pip install '.[test]'
|
$ pip install '.[test]'
|
||||||
$ pytest
|
$ pytest
|
||||||
|
@ -74,4 +53,89 @@ Or with html output (open `htmlcov/index.html` in a browser):
|
||||||
$ coverage html
|
$ coverage html
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
Please refer to our [development wiki](https://flaschengeist.dev/Flaschengeist/flaschengeist/wiki/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).
|
||||||
|
|
||||||
|
#### Code formatting
|
||||||
|
We use [Black](https://github.com/psf/black) as the code formatter.
|
||||||
|
|
||||||
|
Installation:
|
||||||
|
|
||||||
|
pip install black
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
black -l 120 DIRECTORY_OR_FILE
|
||||||
|
|
||||||
|
### Misc
|
||||||
|
#### Git blame
|
||||||
|
When using `git blame` use this to ignore the code formatting commits:
|
||||||
|
|
||||||
|
$ git blame FILE.py --ignore-revs-file .git-blame-ignore-revs
|
||||||
|
Or if you just want to use `git blame`, configure git like this:
|
||||||
|
|
||||||
|
$ git config blame.ignoreRevsFile .git-blame-ignore-revs
|
||||||
|
|
||||||
|
#### Ignore changes on config
|
||||||
|
git update-index --assume-unchanged flaschengeist/flaschengeist.toml
|
||||||
|
|
||||||
|
## Plugin Development
|
||||||
|
### File Structure
|
||||||
|
flaschengeist-example-plugin
|
||||||
|
|> __init__.py
|
||||||
|
|> model.py
|
||||||
|
|> setup.py
|
||||||
|
|
||||||
|
### Files
|
||||||
|
#### \_\_init\_\_.py
|
||||||
|
from flask import Blueprint
|
||||||
|
from flaschengeist.modules import Plugin
|
||||||
|
|
||||||
|
|
||||||
|
example_bp = Blueprint("example", __name__, url_prefix="/example")
|
||||||
|
permissions = ["example_hello"]
|
||||||
|
|
||||||
|
class PluginExample(Plugin):
|
||||||
|
def __init__(self, conf):
|
||||||
|
super().__init__(blueprint=example_bp, permissions=permissions)
|
||||||
|
|
||||||
|
def install(self):
|
||||||
|
from flaschengeist.system.database import db
|
||||||
|
import .model
|
||||||
|
db.create_all()
|
||||||
|
db.session.commit()
|
||||||
|
|
||||||
|
|
||||||
|
@example_bp.route("/hello", methods=['GET'])
|
||||||
|
@login_required(roles=['example_hello'])
|
||||||
|
def __hello(id, **kwargs):
|
||||||
|
return "Hello"
|
||||||
|
|
||||||
|
#### model.py
|
||||||
|
Optional, only needed if you need your own models (database)
|
||||||
|
|
||||||
|
from flaschengeist.system.database import db
|
||||||
|
|
||||||
|
|
||||||
|
class ExampleModel(db.Model):
|
||||||
|
"""Example Model"""
|
||||||
|
__tablename__ = 'example'
|
||||||
|
id = db.Column(db.Integer, primary_key=True)
|
||||||
|
description = db.Column(db.String(240))
|
||||||
|
|
||||||
|
#### setup.py
|
||||||
|
from setuptools import setup, find_packages
|
||||||
|
|
||||||
|
setup(
|
||||||
|
name="flaschengeist-example-plugin",
|
||||||
|
version="0.0.0-dev",
|
||||||
|
packages=find_packages(),
|
||||||
|
install_requires=[
|
||||||
|
"flaschengeist >= 2",
|
||||||
|
],
|
||||||
|
entry_points={
|
||||||
|
"flaschengeist.plugin": [
|
||||||
|
"example = flaschengeist-example-plugin:ExampleModel"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
|
@ -156,11 +156,9 @@ def export(arguments):
|
||||||
app = create_app()
|
app = create_app()
|
||||||
with app.app_context():
|
with app.app_context():
|
||||||
gen = InterfaceGenerator(arguments.namespace, arguments.file)
|
gen = InterfaceGenerator(arguments.namespace, arguments.file)
|
||||||
if not arguments.no_core:
|
|
||||||
gen.run(models)
|
gen.run(models)
|
||||||
if arguments.plugins is not None:
|
if arguments.plugins:
|
||||||
for entry_point in pkg_resources.iter_entry_points("flaschengeist.plugin"):
|
for entry_point in pkg_resources.iter_entry_points("flaschengeist.plugin"):
|
||||||
if len(arguments.plugins) == 0 or entry_point.name in arguments.plugins:
|
|
||||||
plg = entry_point.load()
|
plg = entry_point.load()
|
||||||
if hasattr(plg, "models") and plg.models is not None:
|
if hasattr(plg, "models") and plg.models is not None:
|
||||||
gen.run(plg.models)
|
gen.run(plg.models)
|
||||||
|
@ -185,12 +183,7 @@ if __name__ == "__main__":
|
||||||
parser_export.set_defaults(func=export)
|
parser_export.set_defaults(func=export)
|
||||||
parser_export.add_argument("--file", help="Filename where to save", default="flaschengeist.d.ts")
|
parser_export.add_argument("--file", help="Filename where to save", default="flaschengeist.d.ts")
|
||||||
parser_export.add_argument("--namespace", help="Namespace of declarations", default="FG")
|
parser_export.add_argument("--namespace", help="Namespace of declarations", default="FG")
|
||||||
parser_export.add_argument(
|
parser_export.add_argument("--plugins", help="Also export plugins", action="store_true")
|
||||||
"--no-core",
|
|
||||||
help="Do not export core declarations (only useful in conjunction with --plugins)",
|
|
||||||
action="store_true",
|
|
||||||
)
|
|
||||||
parser_export.add_argument("--plugins", help="Also export plugins (none means all)", nargs="*")
|
|
||||||
|
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
args.func(args)
|
args.func(args)
|
||||||
|
|
Loading…
Reference in New Issue