create-star-app 1.0.0__tar.gz

create_star_app-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Adrian Anton Ladia
+
+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.

create_star_app-1.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.1
+Name: create-star-app
+Version: 1.0.0
+Summary: Flask architecture scaffolding tool — generates core server files for the star app architecture.
+Author-email: "Adrian Anton D. Ladia" <ladiaadrian@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/AALadia/create-star-app
+Project-URL: Repository, https://github.com/AALadia/create-star-app
+Project-URL: Issues, https://github.com/AALadia/create-star-app/issues
+Keywords: flask,scaffolding,boilerplate,code-generator
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# create-star-app
+
+Flask architecture scaffolding tool that generates core server files for the star app architecture.
+
+## What it does
+
+`create-star-app` is an interactive CLI that prompts for project configuration (name, port, timezone, etc.) and generates a ready-to-use Flask server directory with all the boilerplate files pre-configured.
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+Run the CLI from the directory where you want to create your project:
+
+```bash
+create-star-app
+```
+
+You will be prompted for:
+
+- **Project name** (required)
+- **Port** (default: 5000)
+- **Production server endpoint** (default: empty)
+- **Client app subdirectory** (default: client/src/app)
+- **Timezone offset** (default: 8)
+
+The tool will generate the `server/`, `server/schemas/`, and `.vscode/` directories with all template files rendered using your configuration.
+
+## Development
+
+```bash
+pip install -e .
+```
+
+Then run directly:
+
+```bash
+python -m create_star_app.cli
+```

create_star_app-1.0.0/README.md

@@ -0,0 +1,43 @@
+# create-star-app
+
+Flask architecture scaffolding tool that generates core server files for the star app architecture.
+
+## What it does
+
+`create-star-app` is an interactive CLI that prompts for project configuration (name, port, timezone, etc.) and generates a ready-to-use Flask server directory with all the boilerplate files pre-configured.
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Usage
+
+Run the CLI from the directory where you want to create your project:
+
+```bash
+create-star-app
+```
+
+You will be prompted for:
+
+- **Project name** (required)
+- **Port** (default: 5000)
+- **Production server endpoint** (default: empty)
+- **Client app subdirectory** (default: client/src/app)
+- **Timezone offset** (default: 8)
+
+The tool will generate the `server/`, `server/schemas/`, and `.vscode/` directories with all template files rendered using your configuration.
+
+## Development
+
+```bash
+pip install -e .
+```
+
+Then run directly:
+
+```bash
+python -m create_star_app.cli
+```

create_star_app-1.0.0/create_star_app/cli.py

@@ -0,0 +1,59 @@
+from create_star_app.config import ProjectConfig
+from create_star_app import scaffold
+
+
+def _prompt(label: str, default: str = "") -> str:
+    """Prompt the user for input, showing a default value if provided."""
+    if default:
+        raw = input(f"  {label} [{default}]: ").strip()
+        return raw if raw else default
+    else:
+        return input(f"  {label}: ").strip()
+
+
+def main() -> None:
+    print()
+    print("=" * 56)
+    print("  create-star-app")
+    print("  Flask Architecture Scaffolding Tool")
+    print("=" * 56)
+    print()
+
+    # projectName is required — loop until non-empty
+    project_name = ""
+    while not project_name:
+        project_name = _prompt("Project name (required)")
+        if not project_name:
+            print("  Project name cannot be empty. Please try again.")
+
+    port_str = _prompt("Port", "5000")
+    try:
+        port = int(port_str)
+    except ValueError:
+        print(f"  Invalid port '{port_str}', using default 5000.")
+        port = 5000
+
+    production_endpoint = _prompt("Production server endpoint", "")
+    client_subdir = _prompt("Client app subdirectory", "client/src/app")
+
+    tz_str = _prompt("Timezone offset (hours)", "8")
+    try:
+        timezone = int(tz_str)
+    except ValueError:
+        print(f"  Invalid timezone '{tz_str}', using default 8.")
+        timezone = 8
+
+    config = ProjectConfig(
+        projectName=project_name,
+        port=port,
+        productionServerEndpoint=production_endpoint,
+        clientAppSubdir=client_subdir,
+        timezone=timezone,
+    )
+
+    print()
+    scaffold.create_project(config)
+
+
+if __name__ == "__main__":
+    main()

create_star_app-1.0.0/create_star_app/config.py

@@ -0,0 +1,15 @@
+from dataclasses import dataclass, asdict
+
+
+@dataclass
+class ProjectConfig:
+    projectName: str
+    port: int = 5000
+    productionServerEndpoint: str = ""
+    clientAppSubdir: str = "client/src/app"
+    timezone: int = 8
+    ensureIndexesBody: str = "pass"
+
+    def to_template_vars(self) -> dict:
+        """Return a flat dict of all values for string.Template substitution."""
+        return asdict(self)

create_star_app-1.0.0/create_star_app/scaffold.py

@@ -0,0 +1,62 @@
+from pathlib import Path
+from string import Template
+
+from create_star_app.config import ProjectConfig
+
+# Locate the templates directory shipped with this package.
+_TEMPLATES_DIR = Path(__file__).resolve().parent / "templates"
+
+# Files that live outside the server/ directory.
+_ROOT_TARGETS = {
+    "requirements.txt.tmpl": "server/requirements.txt",
+    "pytest.ini.tmpl": "server/pytest.ini",
+}
+
+
+def create_project(config: ProjectConfig) -> None:
+    """Scaffold a new project from templates using the given config."""
+    base = Path.cwd()
+    template_vars = config.to_template_vars()
+
+    # Create target directories.
+    dirs = [
+        base / "server",
+        base / "server" / "schemas",
+        base / ".vscode",
+    ]
+    for d in dirs:
+        d.mkdir(parents=True, exist_ok=True)
+        print(f"  [dir]  {d.relative_to(base)}/")
+
+    # Process every .tmpl file found in the templates directory.
+    tmpl_files = sorted(_TEMPLATES_DIR.glob("*.tmpl"))
+    if not tmpl_files:
+        print("  Warning: no .tmpl files found in templates directory.")
+        return
+
+    for tmpl_path in tmpl_files:
+        tmpl_name = tmpl_path.name                     # e.g. "app.py.tmpl"
+        output_name = tmpl_name.removesuffix(".tmpl")   # e.g. "app.py"
+
+        # Determine the output path.
+        if tmpl_name in _ROOT_TARGETS:
+            rel = Path(_ROOT_TARGETS[tmpl_name])
+        else:
+            rel = Path("server") / output_name
+
+        dest = base / rel
+        dest.parent.mkdir(parents=True, exist_ok=True)
+
+        # Read, substitute, write.
+        raw = tmpl_path.read_text(encoding="utf-8")
+        rendered = Template(raw).safe_substitute(template_vars)
+        dest.write_text(rendered, encoding="utf-8")
+
+        print(f"  [file] {rel}")
+
+    print()
+    print("Project scaffolded successfully! Next steps:")
+    print(f"  1. cd {config.projectName}")
+    print("  2. pip install -r server/requirements.txt")
+    print("  3. python server/app.py")
+    print()

create_star_app-1.0.0/create_star_app/templates/ApiRequests.py.tmpl

@@ -0,0 +1,90 @@
+from route_config import route_config
+from objects import User
+from mongoDb import db
+from typing import List
+from utils import generateRandomString
+import datetime
+from roles import Role, AllRoles, UserRoleTypes
+
+
+class AuthActions():
+
+    @route_config(httpMethod='POST',
+                  jwtRequired=False,
+                  createAccessToken=True,
+                  successMessage='Login successful')
+    def loginWithGoogle(self, firebaseUserObject: dict) -> User:
+        from AuthHandler import FirebaseUserObject
+        from functions import getOrCreateUser
+        firebaseUser = FirebaseUserObject(**firebaseUserObject)
+        user = getOrCreateUser(email=firebaseUser.email,
+                               name=firebaseUser.displayName)
+        return user
+
+    @route_config(httpMethod='POST',
+                  jwtRequired=False,
+                  successMessage='Dev user list fetched successfully')
+    def devGetUserList(self) -> list:
+        from AppConfig import Environment
+        if not Environment().getIsDevEnvironment():
+            raise PermissionError(
+                'This endpoint is only available in dev environments')
+        users = db.read({},
+                        'Users',
+                        projection={
+                            '_id': 1,
+                            'name': 1,
+                            'userType': 1
+                        })
+        return users
+
+    @route_config(httpMethod='POST',
+                  jwtRequired=False,
+                  createAccessToken=True,
+                  successMessage='Dev login successful')
+    def devLogin(self, userId: str) -> dict:
+        from AppConfig import Environment
+        if not Environment().getIsDevEnvironment():
+            raise PermissionError(
+                'This endpoint is only available in dev environments')
+        user = db.read({'_id': userId}, 'Users', findOne=True)
+        if not user:
+            raise ValueError(f'User {userId} not found')
+        return user
+
+
+class RolesActions():
+
+    @route_config(httpMethod='POST',
+                  jwtRequired=True,
+                  successMessage='Roles fetched successfully',
+                  roleAccess='canUpdateUserRole')
+    def getRoles(self, userId: str) -> List[Role]:
+        allRoles = AllRoles()
+        return [x.model_dump(by_alias=True) for x in allRoles.getAllRoles()]
+
+    @route_config(httpMethod='POST',
+                  jwtRequired=True,
+                  successMessage='User role types fetched successfully',
+                  roleAccess='canUpdateUserRole')
+    def getUserRoleTypes(self, userId: str) -> dict:
+        roleTypes = UserRoleTypes()
+        result = {}
+        for userType in roleTypes.getUserTypes():
+            result[userType] = roleTypes.getConfig(userType)
+        allRoleIds = AllRoles().getAllRoleIds()
+        result['superAdmin'] = {
+            roleId: (True if roleId != 'canUpdateUserRole' else False)
+            for roleId in allRoleIds
+        }
+        return result
+
+
+# Add your project-specific action classes below
+
+
+class ApiRequests(AuthActions, RolesActions):
+
+    def __init__(self):
+        AuthActions.__init__(self)
+        RolesActions.__init__(self)

create_star_app-1.0.0/create_star_app/templates/AppConfig.py.tmpl

@@ -0,0 +1,116 @@
+import os
+import datetime
+
+if os.getenv('ENVIRONMENT', '').startswith('local'):
+    from dotenv import load_dotenv
+    load_dotenv(os.path.join(os.path.dirname(os.path.abspath(__file__)), '.env'))
+
+
+class Project:
+
+    def __init__(self):
+        self.projectName = '$projectName'
+        self.projectId = os.getenv('GOOGLE_CLOUD_PROJECT_ID')
+
+
+class PubSubConfig:
+    def __init__(self):
+        import re
+        import importlib.util
+        from services.__abstractService import AbstractService
+
+        services_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'services')
+        self._serviceEnabled = {}
+        for filename in os.listdir(services_dir):
+            if not filename.endswith('.py'):
+                continue
+            module_name = filename[:-3]
+            filepath = os.path.join(services_dir, filename)
+            try:
+                spec = importlib.util.spec_from_file_location(module_name, filepath)
+                module = importlib.util.module_from_spec(spec)
+                spec.loader.exec_module(module)
+            except Exception:
+                continue
+            for var_name, obj in vars(module).items():
+                if isinstance(obj, AbstractService):
+                    service_name = var_name
+                    env_var_name = 'PUBSUB_ENABLED_' + re.sub(r'(?<=[a-z0-9])([A-Z])', r'_\1', service_name).upper()
+                    value = os.getenv(env_var_name)
+                    if value is None:
+                        raise Exception(f"{env_var_name} environment variable is not set")
+                    value = value.lower()
+                    if value not in ['true', 'false']:
+                        raise Exception(f"Invalid {env_var_name} environment variable")
+                    self._serviceEnabled[service_name] = value == 'true'
+
+    def isServiceEnabled(self, serviceName: str) -> bool:
+        if serviceName not in self._serviceEnabled:
+            raise ValueError(f"Unknown service: {serviceName}. Available: {list(self._serviceEnabled.keys())}")
+        return self._serviceEnabled[serviceName]
+
+
+class MongoDb(Project):
+
+    def __init__(self):
+        super().__init__()
+        self.databaseName = os.getenv('databaseName') if os.getenv(
+            'databaseName') else 'test' + self.projectName
+
+    def getDatabaseName(self):
+        return self.databaseName
+
+    def getUseReplicaSet(self):
+        return self.useReplicaSet
+
+
+class Timezone:
+
+    def __init__(self):
+        super().__init__()
+        self.timezone = $timezone
+
+    def getTimezone(self):
+        return datetime.timezone(datetime.timedelta(hours=self.timezone))
+
+
+class Environment:
+
+    def __init__(self):
+        super().__init__()
+        self.environment = os.getenv('ENVIRONMENT')
+        if self.environment not in [
+                'localdev', 'localprod', 'clouddev', 'cloudprod'
+        ]:
+            raise Exception("Invalid environment")
+
+    def getEnvironment(self):
+        return self.environment
+
+    def getIsCloudEnvironment(self):
+        return self.getEnvironment() in ['clouddev', 'cloudprod']
+
+    def getIsProductionEnvironment(self):
+        return self.getEnvironment() in ['cloudprod']
+
+    def getisLocalDevEnvironment(self):
+        return self.getEnvironment() in ['localdev']
+
+    def getisLocalEnvironment(self):
+        return self.getEnvironment() in ['localdev', 'localprod']
+
+    def getIsDevEnvironment(self):
+        return self.getEnvironment() in ['localdev', 'clouddev']
+
+
+class AppConfig(Environment, PubSubConfig, Timezone, MongoDb):
+
+    def __init__(self):
+        Environment.__init__(self)
+        PubSubConfig.__init__(self)
+        Timezone.__init__(self)
+        MongoDb.__init__(self)
+
+
+if __name__ == "__main__":
+    appConfig = AppConfig()