bafser 1.0.0__tar.gz

bafser-1.0.0/.gitignore

@@ -0,0 +1,4 @@
+.venv/
+__pycache__/
+build/
+dist/

bafser-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MixelTe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bafser-1.0.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: bafser
+Version: 1.0.0
+Summary: Base for flask server
+Project-URL: Homepage, https://github.com/MixelTe/bafser
+Project-URL: Issues, https://github.com/MixelTe/bafser/issues
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: ==3.9.*
+Description-Content-Type: text/markdown
+
+# base for flask server by Mixel Te
+
+## requirements.txt
+Python 3.9.5
+```
+flask==2.1.2
+sqlalchemy==2.0.19
+werkzeug==2.3.6
+sqlalchemy_serializer==1.4.1
+pyjwt<2.10
+flask_jwt_extended==4.5.2
+PyMySQL==1.1.1
+```
+
+## usage
+copy `bfs_config.example.py` to project root as `bfs_config.py`
+
+create files:
+
+.gitignore
+```
+.venv
+*__pycache__*
+logs/
+db/
+/images
+/fonts
+secret_key_jwt.txt
+```
+
+```py
+# data/_operations.py
+from bfs import OperationsBase
+
+
+class Operations(OperationsBase):
+    oper_id = ("oper_id", "Operation description")
+    oper_id2 = ("oper_id2", "Operation description")
+    ...
+```
+```py
+# data/_roles.py
+from bfs import RolesBase
+from data._operations import Operations
+
+
+class Roles(RolesBase):
+    role_name = 2
+    role_name2 = 3
+    ...
+
+
+Roles.ROLES = {
+    Roles.role_name: {
+        "name": "Role name",
+        "operations": [
+            Operations.oper_id,
+            Operations.oper_id2,
+        ]
+    },
+    Roles.role_name2: {
+        "name": "Role name 2",
+        "operations": [
+            Operations.oper_id,
+        ]
+    },
+}
+```
+```py
+# data/_tables.py
+from bfs import TablesBase
+
+
+class Tables(TablesBase):
+    TableName = "TableName"
+    AnotherTableName = "AnotherTableName"
+```
+```py
+# data/some_table.py
+from bfs import SqlAlchemyBase, ObjMixin
+from data._tables import Tables
+
+
+class SomeTable(SqlAlchemyBase, ObjMixin):
+    __tablename__ = Tables.SomeTable
+    ...
+
+```
+* `IdMixin` adds `id` column
+* `ObjMixin` adds `id` and `deleted` columns
+
+```py
+# main.py
+import sys
+from bfs import AppConfig, create_app
+from scripts.init_dev_values import init_dev_values
+
+
+app, run = create_app(__name__, AppConfig(
+    MESSAGE_TO_FRONTEND="",
+    DEV_MODE="dev" in sys.argv,
+    DELAY_MODE="delay" in sys.argv,
+)
+    .add_data_folder("FONTS_FOLDER", "fonts")
+    .add_secret_key("API_SECRET_KEY", "secret_key_api.txt")
+)
+
+run(__name__ == "__main__", lambda: init_dev_values(True), port=5001)
+```
+
+### modifying User and Image
+User:
+```py
+from sqlalchemy import Column, String
+from sqlalchemy.orm import Session
+
+from bfs import UserBase
+from data._roles import Roles
+
+
+class User(UserBase):
+    newColumn = Column(String)
+
+    @classmethod
+    def new(cls, creator: "User", login: str, password: str, name: str, roles: list[int], newColumn: str, db_sess: Session = None) -> "User":
+        return super().new(creator, login, password, name, roles, db_sess, newColumn=newColumn)
+
+    @staticmethod
+    def _new(db_sess: Session, user_kwargs: dict, newColumn: str):
+        user = User(**user_kwargs, newColumn=newColumn)
+        changes = [("newColumn", newColumn)]
+        return user, changes
+
+    @staticmethod
+    def create_admin(db_sess: Session):
+        fake_creator = User.get_fake_system()
+        return User.new(fake_creator, "admin", "admin", "Админ", [Roles.admin], "newColumnValue", db_sess=db_sess)
+
+```
+Image:
+```py
+# to use relationship you must name the file something other than image.py
+# img.py for the example, because of the way sqlalchemy finds classes
+image = orm.relationship("data.img.Image")
+```
+```py
+from typing import TypedDict, Union
+from sqlalchemy import Column, String
+
+from bfs import Image as ImageBase, get_json_values
+from data.user import User
+
+
+class ImageJson(TypedDict):
+    data: str
+    name: str
+    newColumnData: str
+
+
+TError = str
+
+
+class Image(ImageBase):
+    newColumn = Column(String)
+
+    @classmethod
+    def new(cls, creator: User, json: ImageJson) -> Union[tuple[None, TError], tuple["Image", None]]:
+        return super().new(creator, json)
+
+    @staticmethod
+    def _new(creator: User, json: ImageJson, image_kwargs):
+        newColumnData, values_error = get_json_values(json, ("newColumnData", None))
+        if values_error:
+            return None, None, values_error
+
+        img = Image(**image_kwargs, newColumn=newColumnData)
+        changes = [("newColumn", newColumnData)]
+        return img, changes, None
+```
+
+#### csv header for requests log
+```csv
+reqid;ip;uid;asctime;method;url;level;message;code;json
+```

bafser-1.0.0/README.md

@@ -0,0 +1,184 @@
+# base for flask server by Mixel Te
+
+## requirements.txt
+Python 3.9.5
+```
+flask==2.1.2
+sqlalchemy==2.0.19
+werkzeug==2.3.6
+sqlalchemy_serializer==1.4.1
+pyjwt<2.10
+flask_jwt_extended==4.5.2
+PyMySQL==1.1.1
+```
+
+## usage
+copy `bfs_config.example.py` to project root as `bfs_config.py`
+
+create files:
+
+.gitignore
+```
+.venv
+*__pycache__*
+logs/
+db/
+/images
+/fonts
+secret_key_jwt.txt
+```
+
+```py
+# data/_operations.py
+from bfs import OperationsBase
+
+
+class Operations(OperationsBase):
+    oper_id = ("oper_id", "Operation description")
+    oper_id2 = ("oper_id2", "Operation description")
+    ...
+```
+```py
+# data/_roles.py
+from bfs import RolesBase
+from data._operations import Operations
+
+
+class Roles(RolesBase):
+    role_name = 2
+    role_name2 = 3
+    ...
+
+
+Roles.ROLES = {
+    Roles.role_name: {
+        "name": "Role name",
+        "operations": [
+            Operations.oper_id,
+            Operations.oper_id2,
+        ]
+    },
+    Roles.role_name2: {
+        "name": "Role name 2",
+        "operations": [
+            Operations.oper_id,
+        ]
+    },
+}
+```
+```py
+# data/_tables.py
+from bfs import TablesBase
+
+
+class Tables(TablesBase):
+    TableName = "TableName"
+    AnotherTableName = "AnotherTableName"
+```
+```py
+# data/some_table.py
+from bfs import SqlAlchemyBase, ObjMixin
+from data._tables import Tables
+
+
+class SomeTable(SqlAlchemyBase, ObjMixin):
+    __tablename__ = Tables.SomeTable
+    ...
+
+```
+* `IdMixin` adds `id` column
+* `ObjMixin` adds `id` and `deleted` columns
+
+```py
+# main.py
+import sys
+from bfs import AppConfig, create_app
+from scripts.init_dev_values import init_dev_values
+
+
+app, run = create_app(__name__, AppConfig(
+    MESSAGE_TO_FRONTEND="",
+    DEV_MODE="dev" in sys.argv,
+    DELAY_MODE="delay" in sys.argv,
+)
+    .add_data_folder("FONTS_FOLDER", "fonts")
+    .add_secret_key("API_SECRET_KEY", "secret_key_api.txt")
+)
+
+run(__name__ == "__main__", lambda: init_dev_values(True), port=5001)
+```
+
+### modifying User and Image
+User:
+```py
+from sqlalchemy import Column, String
+from sqlalchemy.orm import Session
+
+from bfs import UserBase
+from data._roles import Roles
+
+
+class User(UserBase):
+    newColumn = Column(String)
+
+    @classmethod
+    def new(cls, creator: "User", login: str, password: str, name: str, roles: list[int], newColumn: str, db_sess: Session = None) -> "User":
+        return super().new(creator, login, password, name, roles, db_sess, newColumn=newColumn)
+
+    @staticmethod
+    def _new(db_sess: Session, user_kwargs: dict, newColumn: str):
+        user = User(**user_kwargs, newColumn=newColumn)
+        changes = [("newColumn", newColumn)]
+        return user, changes
+
+    @staticmethod
+    def create_admin(db_sess: Session):
+        fake_creator = User.get_fake_system()
+        return User.new(fake_creator, "admin", "admin", "Админ", [Roles.admin], "newColumnValue", db_sess=db_sess)
+
+```
+Image:
+```py
+# to use relationship you must name the file something other than image.py
+# img.py for the example, because of the way sqlalchemy finds classes
+image = orm.relationship("data.img.Image")
+```
+```py
+from typing import TypedDict, Union
+from sqlalchemy import Column, String
+
+from bfs import Image as ImageBase, get_json_values
+from data.user import User
+
+
+class ImageJson(TypedDict):
+    data: str
+    name: str
+    newColumnData: str
+
+
+TError = str
+
+
+class Image(ImageBase):
+    newColumn = Column(String)
+
+    @classmethod
+    def new(cls, creator: User, json: ImageJson) -> Union[tuple[None, TError], tuple["Image", None]]:
+        return super().new(creator, json)
+
+    @staticmethod
+    def _new(creator: User, json: ImageJson, image_kwargs):
+        newColumnData, values_error = get_json_values(json, ("newColumnData", None))
+        if values_error:
+            return None, None, values_error
+
+        img = Image(**image_kwargs, newColumn=newColumnData)
+        changes = [("newColumn", newColumnData)]
+        return img, changes, None
+```
+
+#### csv header for requests log
+```csv
+reqid;ip;uid;asctime;method;url;level;message;code;json
+```

bafser-1.0.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = [
+	"hatchling >= 1.26",
+	"flask == 2.1.2",
+	"sqlalchemy == 2.0.19",
+	"werkzeug == 2.3.6",
+	"sqlalchemy_serializer == 1.4.1",
+	"pyjwt < 2.10",
+	"flask_jwt_extended == 4.5.2",
+	"PyMySQL == 1.1.1",
+	]
+build-backend = "hatchling.build"
+
+[project]
+name = "bafser"
+version = "1.0.0"
+authors = []
+description = "Base for flask server"
+readme = "README.md"
+requires-python = "==3.9.*"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/MixelTe/bafser"
+Issues = "https://github.com/MixelTe/bafser/issues"

bafser-1.0.0/src/bafser/__init__.py

@@ -0,0 +1,48 @@
+# base for flask server by Mixel Te
+
+from .utils.response_msg import response_msg
+from .utils.get_json_values import get_json_values
+
+from .utils.create_file_response import create_file_response
+from .utils.create_folder_for_file import create_folder_for_file
+from .utils.get_datetime_now import get_datetime_now
+from .utils.get_json import get_json
+from .utils.get_json_list_from_req import get_json_list_from_req
+from .utils.get_json_values_from_req import get_json_values_from_req
+from .utils.ip_to_emoji import ip_to_emoji, emoji_to_ip
+from .utils.jsonify_list import jsonify_list
+from .utils.parse_date import parse_date
+from .utils.permission_required import create_permission_required_decorator
+from .utils.permission_required import permission_required, permission_required_any
+from .utils.randstr import randstr
+from .utils.response_not_found import response_not_found
+from .utils.use_db_session import use_db_session
+from .utils.use_userId import use_userId, use_userId_optional
+from .utils.use_user import use_user
+from .utils.use_user_optional import use_user_optional
+
+from .app import AppConfig, create_app
+from .logger import get_logger_frontend, log_frontend_error, get_log_fpath, add_file_logger, ParametrizedLogger
+
+from .db_session import SqlAlchemyBase
+from .table_base import TableBase, IdMixin, ObjMixin
+from .data._tables import TablesBase
+from .data._roles import RolesBase
+from .data.operation import OperationsBase
+from .data.user_role import UserRole
+from .data.user import UserBase
+from .data.log import Log
+from .data.role import Role
+from .data.image import Image
+
+from .scripts.init_db_values import init_db_values
+
+
+class M:
+    DELETE = "DELETE"
+    GET = "GET"
+    HEAD = "HEAD"
+    OPTIONS = "OPTIONS"
+    PATCH = "PATCH"
+    POST = "POST"
+    PUT = "PUT"