swc-utils 0.0.1__tar.gz

swc_utils-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Davis_Software
+
+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.

swc_utils-0.0.1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: swc_utils
+Version: 0.0.1
+Summary: Provides utility functions for SWC projects
+Author-email: Davis_Software <davissoftware6@gmail.com>
+Project-URL: Homepage, https://projects.software-city.org/
+Project-URL: Issues, https://projects.software-city.org/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask==3.0.3
+Requires-Dist: Flask-SQLAlchemy==3.1.1
+
+### SWC Utils
+
+This repository contains a collection of utilities for SWC projects.

swc_utils-0.0.1/README.md

@@ -0,0 +1,3 @@
+### SWC Utils
+
+This repository contains a collection of utilities for SWC projects.

swc_utils-0.0.1/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "swc_utils"
+version = "0.0.1"
+authors = [
+  { name="Davis_Software", email="davissoftware6@gmail.com" },
+]
+description = "Provides utility functions for SWC projects"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "Flask==3.0.3",
+    "Flask-SQLAlchemy==3.1.1"
+]
+
+[project.urls]
+Homepage = "https://projects.software-city.org/"
+Issues = "https://projects.software-city.org/issues"

swc_utils-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

swc_utils-0.0.1/src/swc_utils/database/__init__.py

@@ -0,0 +1,2 @@
+from .connection_profile import ConnectionProfile
+from .database_connection import connect_to_database

swc_utils-0.0.1/src/swc_utils/database/connection_profile.py

@@ -0,0 +1,33 @@
+class ConnectionProfile:
+    def __init__(self, host: str, port: int, database: str, username: str, password: str, sql_type: str):
+        self.mysql_host = host
+        self.mysql_port = port
+        self.mysql_database = database
+        self.mysql_username = username
+        self.mysql_password = password
+        self.sql_type = sql_type
+        
+    @property
+    def connection_uri(self):
+        if self.sql_type == "sqlite":
+            uri_elements = [
+                'sqlite:///',
+                self.mysql_database
+            ]
+        elif self.sql_type == "mysql":
+            uri_elements = [
+                'mysql://',
+                self.mysql_username,
+                ':',
+                self.mysql_password,
+                '@',
+                self.mysql_host,
+                ':',
+                self.mysql_port,
+                '/',
+                self.mysql_database
+            ]
+        else:
+            raise TypeError("No such SQLType", self.sql_type)
+        
+        return ''.join(uri_elements)

swc_utils-0.0.1/src/swc_utils/database/database_connection.py

@@ -0,0 +1,13 @@
+from flask import Flask
+from .connection_profile import ConnectionProfile
+
+
+def connect_to_database(app: Flask, conn: ConnectionProfile, extra_db: dict[str, ConnectionProfile] = None):
+    app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
+    app.config["SQLALCHEMY_DATABASE_URI"] = conn.connection_uri
+
+    if extra_db is not None:
+        for key, value in extra_db.items():
+            extra_db[key] = value.connection_uri
+
+        app.config['SQLALCHEMY_BINDS'] = extra_db

swc_utils-0.0.1/src/swc_utils/other/__init__.py

@@ -0,0 +1 @@
+from .generator_utils import generator_from_callback_consumer

swc_utils-0.0.1/src/swc_utils/other/generator_utils.py

@@ -0,0 +1,26 @@
+import time
+import threading
+
+
+def generator_from_callback_consumer(consumer: callable, args: tuple = None, callback_name: str = "monitor", kwargs: dict = None):
+    args = args or ()
+    kwargs = kwargs or {}
+
+    data = None
+
+    def monitor(new_data):
+        nonlocal data
+        data = new_data
+
+    def thread():
+        kwargs[callback_name] = monitor
+        consumer(*args, **kwargs)
+    thread = threading.Thread(target=thread, daemon=True)
+
+    thread.start()
+    while thread.is_alive():
+        time.sleep(0.1)
+        if data is not None:
+            yield data
+
+    yield data

swc_utils-0.0.1/src/swc_utils/tools/__init__.py

@@ -0,0 +1,2 @@
+from .config import Config
+from .route_loader import load_routes

swc_utils-0.0.1/src/swc_utils/tools/config.py

@@ -0,0 +1,29 @@
+class Config:
+    def __init__(self, config_file):
+        self.config_file = config_file
+        self.__config = self.__read_config()
+
+    def __read_config(self):
+        config = {}
+        with open(self.config_file, 'r', encoding="utf-8") as f:
+            for line in f:
+                line = line.strip()
+                if line and not line.startswith('#'):
+                    key, value = line.split('=')
+                    config[key] = value
+        return config
+
+    def __getitem__(self, item):
+        return self.get(item)
+
+    def get(self, key, default=None):
+        return self.__config.get(key, default)
+
+    def get_bool(self, key, default=None):
+        return self.get(key, default) in ['True', 'true', '1']
+
+    def get_list(self, key, default=None):
+        return self.get(key, default).split(',')
+
+    def get_int(self, key, default=None):
+        return int(self.get(key, default))

swc_utils-0.0.1/src/swc_utils/tools/route_loader.py

@@ -0,0 +1,13 @@
+import os
+import importlib
+
+
+def load_routes(working_dir: str, route_path: str, recursive: bool = True):
+    for file in os.listdir(os.path.join(working_dir, route_path)):
+        if os.path.isdir(os.path.join(working_dir, route_path, file)) and recursive:
+            load_routes(working_dir, os.path.join(route_path, file), recursive)
+
+        if file.endswith(".py"):
+            importlib.import_module(
+                os.path.join(route_path, file).replace("\\", ".").replace("/", ".")[:-3],
+            )

swc_utils-0.0.1/src/swc_utils/web/__init__.py

@@ -0,0 +1,3 @@
+from .auth_manager import auth_required, admin_required, check_admin, check_auth, check_permission
+from .adv_responses import send_binary_image
+from .request_codes import RequestCode

swc_utils-0.0.1/src/swc_utils/web/adv_responses.py

@@ -0,0 +1,18 @@
+
+from flask import make_response, send_file
+
+from .request_codes import RequestCode
+
+
+def send_binary_image(data, content_type="image/jpeg", cache_control=3600):
+    if data is None:
+        return make_response(
+            send_file("static/img/noimage.png"),
+            # RequestCode.ClientError.NotFound
+            RequestCode.Success.OK
+        )
+
+    resp = make_response(data, RequestCode.Success.OK)
+    resp.headers.set("Content-Type", content_type)
+    resp.cache_control.max_age = cache_control
+    return resp

swc_utils-0.0.1/src/swc_utils/web/auth_manager.py

@@ -0,0 +1,43 @@
+from functools import wraps
+from .request_codes import RequestCode
+from flask import session, request, abort, redirect
+
+
+def check_auth():
+    return session.get("logged_in") and session.get("user")
+
+
+def auth_required(func):
+    @wraps(func)
+    def check(*args, **kwargs):
+        if check_auth():
+            return func(*args, **kwargs)
+        return redirect(f"/login?redirect={request.path}")
+
+    return check
+
+
+def check_admin():
+    return session.get("user").get("admin", False) or session.get("admin", False)
+
+
+def check_permission(permission):
+    perms = session.get("user").get("permissions") or []
+    perms.extend(session.get("permissions", []))
+
+    if perms is None:
+        return False
+    if "*" in perms:
+        return True
+
+    return permission in perms
+
+
+def admin_required(func):
+    @wraps(func)
+    def check(*args, **kwargs):
+        if check_admin():
+            return func(*args, **kwargs)
+        return abort(RequestCode.ClientError.Unauthorized)
+
+    return check

swc_utils-0.0.1/src/swc_utils/web/request_codes.py

@@ -0,0 +1,89 @@
+class RequestCode:
+    """
+    Represents a collection of all possible status codes
+    of a server response. They are ordered by category,
+    which makes them more readable for other developers.
+    Instead of writing 200, you could type StopCodes.Success.OK
+    and everyone reading your code will know that the response
+    was handled successfully.
+
+    For more information on the different response codes, visit:
+    https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
+    """
+
+    class Info:
+        Continue = 200
+        SwitchingProtocols = 101
+        Processing = 102
+        EarlyHints = 103
+
+    class Success:
+        OK = 200
+        Created = 201
+        Accepted = 202
+        NAuthInfo = 203
+        NoContent = 204
+        ResetContent = 205
+        PartialContent = 206
+        MultiStatus = 207
+        AlreadyReported = 208
+        IMUsed = 226
+
+    class Redirect:
+        MultipleChoices = 300
+        MovedPermanently = 301
+        MovedTemporarily = 302
+        SeeOther = 303
+        NotModified = 304
+        UseProxy = 305
+        SwitchProxy = 306
+        TemporaryRedirect = 307
+        PermanentRedirect = 308
+
+    class ClientError:
+        BadRequest = 400
+        Unauthorized = 401
+        PaymentRequired = 402
+        Forbidden = 403
+        NotFound = 404
+        MethodNotAllowed = 405
+        NotAcceptable = 406
+        ProxyAuthRequired = 407
+        RequestTimeout = 408
+        Conflict = 409
+        Gone = 410
+        LengthRequired = 411
+        PreconditionFailed = 412
+        PayloadTooLarge = 413
+        URITooLong = 414
+        UnsupportedMediaType = 415
+        RangeNotSatisfiable = 416
+        ImATeapot = 418
+        ExpectationFailed = 417
+        PolicyNotFulfilled = 420
+        MisdirectedRequest = 421
+        UnprocessableEntity = 422
+        Locked = 423
+        FailedDependency = 424
+        TooEarly = 425
+        UpgradeRequired = 426
+        PreconditionRequired = 428
+        TooManyRequests = 429
+        RequestHeaderFieldsTooLarge = 431
+        NoResponse = 444
+        ClientCloseRequest = 499
+        UnavailableForLegalReasons = 451
+
+    class ServerError:
+        InternalServerError = 500
+        NotImplemented = 501
+        BadGateway = 502
+        ServiceUnavailable = 503
+        GatewayTimeout = 504
+        HTTPVersionNotSupported = 505
+        VariantsAlsoNegotiates = 506
+        InsufficientStorage = 507
+        LoopDetected = 508
+        BandwidthLimitExceeded = 509
+        NotExtended = 510
+        NetworkAuthRequired = 511

swc_utils-0.0.1/src/swc_utils/wsl/__init__.py

@@ -0,0 +1 @@
+from .wsl_compatability import get_wsl_path, make_wsl_command, get_local_wsl_temp_dir

swc_utils-0.0.1/src/swc_utils/wsl/wsl_compatability.py

@@ -0,0 +1,24 @@
+from ..tools.config import Config
+
+
+def get_wsl_path(config: Config, path: str):
+    if not config.get_bool("USE_WSL", False):
+        return path
+
+    path_parts = path.split(":\\")
+    return f"/mnt/{path_parts[0].lower()}/" + path_parts[1].replace('\\', '/')
+
+
+def make_wsl_command(config: Config, command: list):
+    if not config.get_bool("USE_WSL", False):
+        return command
+
+    dist = config["WSL_DISTRO"]
+    return ["wsl", "-d", dist, *command]
+
+
+def get_local_wsl_temp_dir(config: Config):
+    if not config.get_bool("USE_WSL", False):
+        return "/tmp/"
+
+    return f"\\\\wsl.localhost\\{config['WSL_DISTRO']}\\tmp\\"

swc_utils-0.0.1/src/swc_utils.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: swc_utils
+Version: 0.0.1
+Summary: Provides utility functions for SWC projects
+Author-email: Davis_Software <davissoftware6@gmail.com>
+Project-URL: Homepage, https://projects.software-city.org/
+Project-URL: Issues, https://projects.software-city.org/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask==3.0.3
+Requires-Dist: Flask-SQLAlchemy==3.1.1
+
+### SWC Utils
+
+This repository contains a collection of utilities for SWC projects.

swc_utils-0.0.1/src/swc_utils.egg-info/SOURCES.txt

@@ -0,0 +1,23 @@
+LICENSE
+README.md
+pyproject.toml
+src/swc_utils/__init__.py
+src/swc_utils.egg-info/PKG-INFO
+src/swc_utils.egg-info/SOURCES.txt
+src/swc_utils.egg-info/dependency_links.txt
+src/swc_utils.egg-info/requires.txt
+src/swc_utils.egg-info/top_level.txt
+src/swc_utils/database/__init__.py
+src/swc_utils/database/connection_profile.py
+src/swc_utils/database/database_connection.py
+src/swc_utils/other/__init__.py
+src/swc_utils/other/generator_utils.py
+src/swc_utils/tools/__init__.py
+src/swc_utils/tools/config.py
+src/swc_utils/tools/route_loader.py
+src/swc_utils/web/__init__.py
+src/swc_utils/web/adv_responses.py
+src/swc_utils/web/auth_manager.py
+src/swc_utils/web/request_codes.py
+src/swc_utils/wsl/__init__.py
+src/swc_utils/wsl/wsl_compatability.py

swc_utils-0.0.1/src/swc_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

swc_utils-0.0.1/src/swc_utils.egg-info/requires.txt

@@ -0,0 +1,2 @@
+Flask==3.0.3
+Flask-SQLAlchemy==3.1.1

swc_utils-0.0.1/src/swc_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+swc_utils