square_administration 4.0.0__tar.gz

square_administration-4.0.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.3
+Name: square_administration
+Version: 4.0.0
+Summary: common business layer for my personal server.
+Keywords: administration,fastapi,backend
+Author: Parth Mukesh Mangtani
+Author-email: Parth Mukesh Mangtani <thepmsquare@gmail.com>
+License: GPLv3
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Utilities
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Framework :: FastAPI
+Requires-Dist: uvicorn>=0.24.0.post1
+Requires-Dist: fastapi>=0.104.1
+Requires-Dist: pydantic>=2.5.3
+Requires-Dist: requests>=2.32.3
+Requires-Dist: bcrypt>=4.2.0
+Requires-Dist: httpx>=0.27.2
+Requires-Dist: square-commons>=2.1.0
+Requires-Dist: square-logger>=3.0.0
+Requires-Dist: square-database-helper>=2.0.0
+Requires-Dist: square-database-structure>=1.0.0
+Requires-Dist: square-authentication-helper>=3.0.0
+Requires-Dist: pytest>=8.3.3 ; extra == 'all'
+Requires-Dist: pytest>=8.3.3 ; extra == 'dev'
+Requires-Python: >=3.12
+Project-URL: homepage, https://github.com/thepmsquare/square_administration
+Provides-Extra: all
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# square_administration
+
+> 📌 versioning: see [CHANGELOG.md](./CHANGELOG.md).
+
+## about
+
+administration business layer for my personal server.
+
+## goals
+
+- administration-specific logic
+- api grouped by usecase
+- integration with square_*
+- simple and sufficient
+
+## installation
+
+```shell
+pip install square_administration
+```
+
+## usage
+
+### configuration
+
+update the settings in `config.ini` and `config.testing.ini` to match your environment (urls, logging, etc.).
+
+### running the service
+
+```shell
+python square_common_bl/main.py
+```
+
+## env
+
+- python>=3.12.0
+
+> feedback is appreciated. thank you!

square_administration-4.0.0/README.md

@@ -0,0 +1,38 @@
+# square_administration
+
+> 📌 versioning: see [CHANGELOG.md](./CHANGELOG.md).
+
+## about
+
+administration business layer for my personal server.
+
+## goals
+
+- administration-specific logic
+- api grouped by usecase
+- integration with square_*
+- simple and sufficient
+
+## installation
+
+```shell
+pip install square_administration
+```
+
+## usage
+
+### configuration
+
+update the settings in `config.ini` and `config.testing.ini` to match your environment (urls, logging, etc.).
+
+### running the service
+
+```shell
+python square_common_bl/main.py
+```
+
+## env
+
+- python>=3.12.0
+
+> feedback is appreciated. thank you!

square_administration-4.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["uv-build"]
+build-backend = "uv_build"
+
+[project]
+name = "square_administration"
+version = "4.0.0"
+description = "common business layer for my personal server."
+readme = "README.md"
+readme-content-type = "text/markdown"
+requires-python = ">=3.12"
+license = { text = "GPLv3" }
+authors = [
+    { name = "Parth Mukesh Mangtani", email = "thepmsquare@gmail.com" },
+]
+urls = { homepage = "https://github.com/thepmsquare/square_administration" }
+keywords = ["administration", "fastapi", "backend"]
+dependencies = [
+    "uvicorn>=0.24.0.post1",
+    "fastapi>=0.104.1",
+    "pydantic>=2.5.3",
+    "requests>=2.32.3",
+    "bcrypt>=4.2.0",
+    "httpx>=0.27.2",
+    "square_commons>=2.1.0",
+    "square_logger>=3.0.0",
+    "square_database_helper>=2.0.0",
+    "square_database_structure>=1.0.0",
+    "square_authentication_helper>=3.0.0",
+]
+optional-dependencies = { all = ["pytest>=8.3.3"], dev = ["pytest>=8.3.3"] }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Utilities",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Framework :: FastAPI"
+]
+
+[tool.uv.build-backend]
+module-name = "square_administration"
+module-root = ""
+source-include = ["square_administration/data/*"]

square_administration-4.0.0/square_administration/configuration.py

@@ -0,0 +1,120 @@
+import os
+import sys
+
+from square_authentication_helper import SquareAuthenticationHelper
+from square_commons import ConfigReader
+from square_database_helper import SquareDatabaseHelper
+from square_logger.main import SquareLogger
+
+try:
+    config_file_path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "data", "config.ini"
+    )
+    config_sample_file_path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), "data", "config.sample.ini"
+    )
+    ldict_configuration = ConfigReader(
+        config_file_path, config_sample_file_path
+    ).read_configuration()
+    # get all vars and typecast
+    # ===========================================
+    # general
+    config_str_module_name = ldict_configuration["GENERAL"]["MODULE_NAME"]
+    config_str_app_name = ldict_configuration["GENERAL"]["APP_NAME"]
+    # ===========================================
+
+    # ===========================================
+    # environment
+    config_str_host_ip = ldict_configuration["ENVIRONMENT"]["HOST_IP"]
+    config_int_host_port = int(ldict_configuration["ENVIRONMENT"]["HOST_PORT"])
+    config_list_allow_origins = eval(
+        ldict_configuration["ENVIRONMENT"]["ALLOW_ORIGINS"]
+    )
+    config_str_log_file_name = ldict_configuration["ENVIRONMENT"]["LOG_FILE_NAME"]
+    config_str_admin_password_hash = ldict_configuration["ENVIRONMENT"][
+        "ADMIN_PASSWORD_HASH"
+    ]
+
+    config_str_ssl_crt_file_path = ldict_configuration["ENVIRONMENT"][
+        "SSL_CRT_FILE_PATH"
+    ]
+    config_str_ssl_key_file_path = ldict_configuration["ENVIRONMENT"][
+        "SSL_KEY_FILE_PATH"
+    ]
+    config_str_cookie_domain = ldict_configuration["ENVIRONMENT"]["COOKIE_DOMAIN"]
+    config_str_db_ip = ldict_configuration["ENVIRONMENT"]["DB_IP"]
+    config_int_db_port = int(ldict_configuration["ENVIRONMENT"]["DB_PORT"])
+    config_str_db_username = ldict_configuration["ENVIRONMENT"]["DB_USERNAME"]
+    config_str_db_password = ldict_configuration["ENVIRONMENT"]["DB_PASSWORD"]
+    # ===========================================
+
+    # ===========================================
+    # square_logger
+    config_int_log_level = int(ldict_configuration["SQUARE_LOGGER"]["LOG_LEVEL"])
+    config_str_log_path = ldict_configuration["SQUARE_LOGGER"]["LOG_PATH"]
+    config_int_log_backup_count = int(
+        ldict_configuration["SQUARE_LOGGER"]["LOG_BACKUP_COUNT"]
+    )
+    config_formatter_choice = ldict_configuration["SQUARE_LOGGER"]["FORMATTER_CHOICE"]
+    if config_formatter_choice not in ("human_readable", "json"):
+        raise ValueError(f"Invalid formatter choice: {config_formatter_choice}")
+    config_bool_enable_redaction = eval(
+        ldict_configuration["SQUARE_LOGGER"]["ENABLE_REDACTION"]
+    )
+    # ===========================================
+
+    # ===========================================
+    # square_database_helper
+
+    config_str_square_database_protocol = ldict_configuration["SQUARE_DATABASE_HELPER"][
+        "SQUARE_DATABASE_PROTOCOL"
+    ]
+    config_str_square_database_ip = ldict_configuration["SQUARE_DATABASE_HELPER"][
+        "SQUARE_DATABASE_IP"
+    ]
+    config_int_square_database_port = int(
+        ldict_configuration["SQUARE_DATABASE_HELPER"]["SQUARE_DATABASE_PORT"]
+    )
+    # ===========================================
+    # ===========================================
+    # square_authentication_helper
+
+    config_str_square_authentication_protocol = ldict_configuration[
+        "SQUARE_AUTHENTICATION_HELPER"
+    ]["SQUARE_AUTHENTICATION_PROTOCOL"]
+    config_str_square_authentication_ip = ldict_configuration[
+        "SQUARE_AUTHENTICATION_HELPER"
+    ]["SQUARE_AUTHENTICATION_IP"]
+    config_int_square_authentication_port = int(
+        ldict_configuration["SQUARE_AUTHENTICATION_HELPER"][
+            "SQUARE_AUTHENTICATION_PORT"
+        ]
+    )
+    # ===========================================
+    # Initialize logger
+    global_object_square_logger = SquareLogger(
+        log_file_name=config_str_log_file_name,
+        log_level=config_int_log_level,
+        log_path=config_str_log_path,
+        log_backup_count=config_int_log_backup_count,
+        formatter_choice=config_formatter_choice,
+        enable_redaction=config_bool_enable_redaction,
+    )
+
+    global_object_square_database_helper = SquareDatabaseHelper(
+        param_str_square_database_ip=config_str_square_database_ip,
+        param_int_square_database_port=config_int_square_database_port,
+        param_str_square_database_protocol=config_str_square_database_protocol,
+    )
+    global_object_square_authentication_helper = SquareAuthenticationHelper(
+        param_str_square_authentication_protocol=config_str_square_authentication_protocol,
+        param_str_square_authentication_ip=config_str_square_authentication_ip,
+        param_int_square_authentication_port=config_int_square_authentication_port,
+    )
+
+except Exception as e:
+    print(
+        "\033[91mMissing or incorrect config.ini file.\n"
+        "Error details: " + str(e) + "\033[0m"
+    )
+    sys.exit()

square_administration-4.0.0/square_administration/data/config.sample.ini

@@ -0,0 +1,56 @@
+[GENERAL]
+MODULE_NAME = square_administration
+APP_NAME = square_admin
+
+[ENVIRONMENT]
+HOST_IP = 0.0.0.0
+HOST_PORT = 10111
+ALLOW_ORIGINS = ["http://localhost:10111"]
+
+LOG_FILE_NAME = square_administration
+
+ADMIN_PASSWORD_HASH = $2b$12$tDw4ZR0guiF5s5oVve5PcuELhlWO.lUH.OChPoeWVn95ac7QJlndq
+
+# absolute path (mandatory only for http)
+SSL_CRT_FILE_PATH = ssl.crt
+SSL_KEY_FILE_PATH = ssl.key
+
+COOKIE_DOMAIN = localhost
+
+DB_IP = localhost
+DB_PORT = 10001
+DB_USERNAME = postgres
+DB_PASSWORD = dummy
+
+[SQUARE_LOGGER]
+
+# | Log Level | Value |
+# | --------- | ----- |
+# | CRITICAL  | 50    |
+# | ERROR     | 40    |
+# | WARNING   | 30    |
+# | INFO      | 20    |
+# | DEBUG     | 10    |
+# | NOTSET    | 0     |
+
+LOG_LEVEL = 20
+# absolute or relative path
+LOG_PATH = logs
+# number of backup log files to keep during rotation
+# if backupCount is zero, rollover never occurs.
+LOG_BACKUP_COUNT = 3
+# json or human_readable
+FORMATTER_CHOICE = json
+ENABLE_REDACTION = True
+
+[SQUARE_DATABASE_HELPER]
+
+SQUARE_DATABASE_PROTOCOL = http
+SQUARE_DATABASE_IP = localhost
+SQUARE_DATABASE_PORT = 10010
+
+[SQUARE_AUTHENTICATION_HELPER]
+
+SQUARE_AUTHENTICATION_PROTOCOL = http
+SQUARE_AUTHENTICATION_IP = localhost
+SQUARE_AUTHENTICATION_PORT = 10011

square_administration-4.0.0/square_administration/data/config.testing.sample.ini

@@ -0,0 +1,57 @@
+[GENERAL]
+MODULE_NAME = square_administration
+APP_NAME = square_admin
+
+[ENVIRONMENT]
+HOST_IP = 0.0.0.0
+HOST_PORT = 10111
+ALLOW_ORIGINS = ["http://localhost:10111"]
+
+LOG_FILE_NAME = square_administration
+
+ADMIN_PASSWORD_HASH = $2b$12$tDw4ZR0guiF5s5oVve5PcuELhlWO.lUH.OChPoeWVn95ac7QJlndq
+
+# absolute path (mandatory only for http)
+SSL_CRT_FILE_PATH = ssl.crt
+SSL_KEY_FILE_PATH = ssl.key
+
+COOKIE_DOMAIN = localhost
+
+DB_IP = raspi.thepmsquare.com
+DB_PORT = 15432
+DB_USERNAME = postgres
+DB_PASSWORD = testing_password
+
+
+[SQUARE_LOGGER]
+
+# | Log Level | Value |
+# | --------- | ----- |
+# | CRITICAL  | 50    |
+# | ERROR     | 40    |
+# | WARNING   | 30    |
+# | INFO      | 20    |
+# | DEBUG     | 10    |
+# | NOTSET    | 0     |
+
+LOG_LEVEL = 20
+# absolute or relative path
+LOG_PATH = logs
+# number of backup log files to keep during rotation
+# if backupCount is zero, rollover never occurs.
+LOG_BACKUP_COUNT = 3
+# json or human_readable
+FORMATTER_CHOICE = json
+ENABLE_REDACTION = True
+
+[SQUARE_DATABASE_HELPER]
+
+SQUARE_DATABASE_PROTOCOL = http
+SQUARE_DATABASE_IP = raspi.thepmsquare.com
+SQUARE_DATABASE_PORT = 20010
+
+[SQUARE_AUTHENTICATION_HELPER]
+
+SQUARE_AUTHENTICATION_PROTOCOL = http
+SQUARE_AUTHENTICATION_IP = raspi.thepmsquare.com
+SQUARE_AUTHENTICATION_PORT = 20011

square_administration-4.0.0/square_administration/main.py

@@ -0,0 +1,58 @@
+from fastapi import FastAPI, status
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.responses import JSONResponse
+from square_commons import get_api_output_in_standard_format
+from uvicorn import run
+
+from square_administration.configuration import (
+    config_int_host_port,
+    config_str_host_ip,
+    global_object_square_logger,
+    config_str_module_name,
+    config_str_ssl_key_file_path,
+    config_str_ssl_crt_file_path,
+    config_list_allow_origins,
+)
+from square_administration.routes import core, authentication
+from square_administration.utils.common import is_https
+
+app = FastAPI()
+
+app.add_middleware(
+    CORSMiddleware,
+    allow_credentials=True,
+    allow_origins=config_list_allow_origins,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+app.include_router(core.router)
+app.include_router(authentication.router)
+
+
+@app.get("/")
+@global_object_square_logger.auto_logger()
+async def root():
+    output_content = get_api_output_in_standard_format(log=config_str_module_name)
+    return JSONResponse(status_code=status.HTTP_200_OK, content=output_content)
+
+
+if __name__ == "__main__":
+    try:
+        if is_https():
+            run(
+                app,
+                host=config_str_host_ip,
+                port=config_int_host_port,
+                ssl_certfile=config_str_ssl_crt_file_path,
+                ssl_keyfile=config_str_ssl_key_file_path,
+            )
+        else:
+            run(
+                app,
+                host=config_str_host_ip,
+                port=config_int_host_port,
+            )
+
+    except Exception as exc:
+        global_object_square_logger.logger.critical(exc, exc_info=True)

square_administration-4.0.0/square_administration/messages.py

@@ -0,0 +1,16 @@
+messages = {
+    "REGISTRATION_SUCCESSFUL": "registration was successful. welcome aboard!",
+    "LOGIN_SUCCESSFUL": "you have logged in successfully.",
+    "LOGOUT_SUCCESSFUL": "you have logged out successfully.",
+    "INCORRECT_USERNAME": "the username you entered does not exist.",
+    "INCORRECT_PASSWORD": "the password you entered is incorrect. please try again.",
+    "GENERIC_CREATION_SUCCESSFUL": "records created successfully.",
+    "GENERIC_READ_SUCCESSFUL": "data retrieved successfully.",
+    "GENERIC_UPDATE_SUCCESSFUL": "your information has been updated successfully.",
+    "GENERIC_DELETE_SUCCESSFUL": "your records have been deleted successfully.",
+    "GENERIC_400": "the request is invalid or cannot be processed.",
+    "GENERIC_500": "an internal server error occurred. please try again later.",
+    "INCORRECT_ACCESS_TOKEN": "the access token provided is invalid or expired.",
+    "INCORRECT_REFRESH_TOKEN": "the refresh token provided is invalid or expired.",
+    "REFRESH_TOKEN_NOT_FOUND": "refresh token not found. please login again.",
+}

square_administration-4.0.0/square_administration/pydantic_models/authentication.py

@@ -0,0 +1,36 @@
+from pydantic import BaseModel
+
+
+class RegisterUsernameV0(BaseModel):
+    username: str
+    password: str
+    admin_password: str
+
+
+class LoginUsernameV0(BaseModel):
+    username: str
+    password: str
+
+
+class RemoveAppForSelfV0(BaseModel):
+    password: str
+
+
+class ResetPasswordAndLoginUsingBackupCodeV0(BaseModel):
+    backup_code: str
+    username: str
+    new_password: str
+    logout_other_sessions: bool = False
+
+
+class ResetPasswordAndLoginUsingResetEmailCodeV0(BaseModel):
+    reset_email_code: str
+    username: str
+    new_password: str
+    logout_other_sessions: bool = False
+
+
+class UpdatePasswordV0(BaseModel):
+    old_password: str
+    new_password: str
+    logout_other_sessions: bool = False

square_administration-4.0.0/square_administration/pydantic_models/core.py

@@ -0,0 +1,12 @@
+from typing import Optional, List
+
+from pydantic import BaseModel, Field
+from square_database_structure.square.greeting.tables import Greeting
+
+
+class GetAllGreetingsV0(BaseModel):
+    order_by: List[str] = Field(
+        default_factory=lambda: [f"-{Greeting.greeting_datetime.name}"]
+    )
+    limit: Optional[int] = None
+    offset: int = 0