mvcfw 0.1.0__tar.gz

mvcfw-0.1.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: mvcfw
+Version: 0.1.0
+Summary: MVCFW - Python Desktop MVC Framework
+Author: Ritesh
+Requires-Python: >=3.10
+Requires-Dist: customtkinter
+Requires-Dist: SQLAlchemy
+Requires-Dist: watchdog

mvcfw-0.1.0/README.md

@@ -0,0 +1,274 @@
+# MVCFW
+
+MVCFW is a Python framework for building desktop applications using the **Model-View-Controller (MVC)** architecture.
+
+**Version:** 0.1.0
+**Created and maintained by Ritesh Kashyap**
+
+## Features
+
+* MVC architecture
+* Hierarchical routing
+* Master pages / layouts
+* SQLAlchemy-based ORM
+* Database migrations
+* Reusable UI components
+* Project and application scaffolding
+* Development server with auto-reload
+* Command-line interface
+
+## Requirements
+
+* Python 3.10+
+* CustomTkinter
+* SQLAlchemy
+* Watchdog
+
+## Installation
+
+Install MVCFW with pip:
+
+```bash
+pip install mvcfw
+```
+
+For development installation from source:
+
+```bash
+pip install -e .
+```
+
+## Create a Project
+
+Create a new MVCFW project:
+
+```bash
+mvcfw startproject MyProject
+```
+
+Move into the project:
+
+```bash
+cd MyProject
+```
+
+Run the application:
+
+```bash
+python run.py
+```
+
+## Create an Application
+
+Inside your project:
+
+```bash
+python manager.py startapp students
+```
+
+This generates:
+
+```text
+students/
+├── models.py
+├── controller.py
+├── router.py
+├── __init__.py
+└── views/
+    ├── index.py
+    └── __init__.py
+```
+
+The application is automatically added to `INSTALLED_APPS`.
+
+## Routing
+
+MVCFW uses hierarchical routing.
+
+Project-level routing connects an application router:
+
+```python
+ROUTING={
+    "Main":app_router.ROUTING
+}
+```
+
+Routes can then be accessed using:
+
+```python
+routingjunction.goto(["Main","index"])
+```
+
+## Master Pages
+
+Views can use a master page/layout:
+
+```python
+from fwfiles.UI.decorators import use_masterpage
+
+@use_masterpage("app.views.layout.Layout_default")
+class Index(ctk.CTkFrame):
+    ...
+```
+
+The master page provides a reusable layout while the view renders its content inside the layout body.
+
+## ORM
+
+MVCFW provides a simple SQLAlchemy-based ORM.
+
+Example:
+
+```python
+from fwfiles.ORM.base import Model
+from fwfiles.ORM import feilds
+
+class Student(Model):
+    __tablename__="students"
+
+    id=feilds.IntegerField(primary_key=True,increment=True)
+    name=feilds.CharField(max_length=255)
+    email=feilds.CharField(max_length=255)
+```
+
+Basic operations include:
+
+```python
+Student.all()
+Student.filter(name="Ritesh")
+
+student.save()
+student.delete()
+```
+
+## Database Migrations
+
+Create migrations:
+
+```bash
+python manager.py makemigrations
+```
+
+Apply migrations:
+
+```bash
+python manager.py migrate
+```
+
+Reset the database:
+
+```bash
+python manager.py reset_db
+```
+
+View installed applications:
+
+```bash
+python manager.py show_apps
+```
+
+## Development Server
+
+Run the development server:
+
+```bash
+python manager.py runserver
+```
+
+MVCFW uses `watchdog` for detecting file changes during development.
+
+## Reference Application
+
+Generate the MVCFW reference application:
+
+```bash
+mvcfw start_ref_app
+```
+
+The reference application demonstrates:
+
+* MVC
+* Routing
+* Master pages
+* ORM
+* Database migrations
+* Reusable UI components
+
+## CLI
+
+Check the framework version:
+
+```bash
+mvcfw --version
+```
+
+You can also use:
+
+```bash
+mvcfw version
+mvcfw -v
+```
+
+Create a project:
+
+```bash
+mvcfw startproject <project_name>
+```
+
+Create the reference application:
+
+```bash
+mvcfw start_ref_app
+```
+
+## Project Commands
+
+Inside a project:
+
+```bash
+python manager.py startapp <app_name>
+python manager.py makemigrations
+python manager.py migrate
+python manager.py reset_db
+python manager.py show_apps
+python manager.py runserver
+```
+
+## Project Structure
+
+A project created with `startproject` has the following structure:
+
+```text
+MyProject/
+├── app/
+│   ├── models.py
+│   ├── controller.py
+│   ├── router.py
+│   └── views/
+├── migrations/
+├── MyProject/
+│   ├── config.py
+│   └── router.py
+├── manager.py
+└── run.py
+```
+
+## Architecture
+
+MVCFW follows the Model-View-Controller architecture:
+
+```text
+Model
+  ↓
+Controller
+  ↓
+View
+```
+
+Routing connects routes to controllers, while master pages provide reusable UI layouts.
+
+## Author
+
+**Ritesh Kashyap**
+
+MVCFW is an open-source project focused on making desktop application development with Python and MVC architecture simpler.

mvcfw-0.1.0/fw/contrib/ui.py

@@ -0,0 +1,106 @@
+from tkinter import ttk
+import customtkinter as ctk
+from fwfiles import routingjunction
+
+
+
+class Card(ctk.CTkFrame):
+    def __init__(
+        self, master, title="Card Title", content="Card Content...", button_text=None, button_command=None, **kwargs):
+        super().__init__(master, corner_radius=10, **kwargs)
+
+        self.title_label = ctk.CTkLabel(self, text=title,font=("Helvetica", 16, "bold"))
+        self.title_label.pack(pady=(10, 0), padx=10, anchor="w")
+
+        self.content_label = ctk.CTkLabel(self, text=content)
+        self.content_label.pack(pady=(0, 5), padx=10, anchor="w")
+
+        self.button = None
+
+        if button_text:
+            self.button = ctk.CTkButton( self, text=button_text, command=button_command)
+            self.button.pack(pady=10, padx=10, anchor="e", fill="both")
+
+
+
+
+
+class InfoCard(ctk.CTkFrame):
+    def __init__(self, master, title="Card Title", content="Card Content...", **kwargs):
+        super().__init__(master, corner_radius=10, **kwargs)
+
+        self.title_label = ctk.CTkLabel(self, text=title, font=("Helvetica", 16, "bold"))
+        self.title_label.pack(pady=(10, 0), padx=10, anchor="w")
+
+        self.content_label = ctk.CTkLabel(self, text=content)
+        self.content_label.pack(pady=(0, 5), padx=10, anchor="w")
+
+
+
+
+class Table(ctk.CTkFrame):
+    def __init__(self, master, headings=None, data=None, height=12, **kwargs):
+        super().__init__(master, corner_radius=10, **kwargs)
+
+        self.headings = headings or []
+        self.data = data or []
+
+        style = ttk.Style()
+        style.configure("Treeview", font=("Roboto Narrow", 10))
+        style.configure("Treeview.Heading", font=("Roboto", 10, "bold"))
+
+        self.table = ttk.Treeview(self, columns=self.headings, show="headings", height=height)
+
+        for col in self.headings:
+            self.table.heading(col, text=col)
+            self.table.column(col, anchor="w")
+
+        self.table.pack(padx=10, pady=10, anchor="w", fill="both", expand=True)
+
+        self.refresh(self.data)
+
+    def refresh(self, data):
+        self.clear()
+
+        for row in data:
+            self.table.insert("", "end", values=row)
+
+    def clear(self):
+        for item in self.table.get_children():
+            self.table.delete(item)  
+    
+
+class LeftSidebar(ctk.CTkFrame):
+    def __init__(self, master, items=None, width=200, fg_color=None, **kwargs):
+        super().__init__(master, width=width, fg_color=fg_color, corner_radius=0, **kwargs)
+        self.items = items or []
+        self.create_items()
+
+    def create_items(self):
+        for item in self.items:
+            text = item.get("text", "")
+            command = item.get("command")
+
+            button = ctk.CTkButton(self, fg_color="#ebebeb", text_color="#292828", text=text, command=command)
+
+            button.pack(padx=5, pady=5, fill="x")
+
+class CardGrid(ctk.CTkFrame):
+    def __init__(self, master, cards=None, card_width=250, padx=10, pady=10, fg_color="#ebebeb", **kwargs):
+        super().__init__(master, fg_color=fg_color, **kwargs)
+        self.cards, self.card_width, self.padx, self.pady = cards or [], card_width, padx, pady
+        self.bind("<Configure>", self.arrange_cards)
+
+    def arrange_cards(self, event=None):
+        cols = max(1, self.winfo_width() // self.card_width)
+        for i, card in enumerate(self.cards): card.grid(row=i // cols, column=i % cols, padx=self.padx, pady=self.pady, sticky="nsew")
+        for c in range(cols): self.grid_columnconfigure(c, weight=1)
+
+    def add_card(self, card): self.cards.append(card); self.arrange_cards()
+    def clear(self):
+        for card in self.cards: card.grid_forget()
+        self.cards.clear()
+        
+
+
+

mvcfw-0.1.0/fwfiles/ORM/base.py

@@ -0,0 +1,29 @@
+from .db import Base, DBconnection
+
+db=DBconnection()
+
+class Model(Base):
+    __abstract__=True
+
+
+    @classmethod
+    def create_table(cls):
+        db.create_tables()
+
+    @classmethod
+    def all(cls):
+        return db.session.query(cls).all()
+    
+    @classmethod
+    def filter(cls, **kwargs):
+        return db.session.query(cls).filter_by(**kwargs).all()
+
+    def save(self):
+        db.session.add(self)
+        db.session.commit()
+    
+    def delete(self):
+        db.session.delete(self)
+        db.session.commit()
+        
+    

mvcfw-0.1.0/fwfiles/ORM/commands.py

@@ -0,0 +1,12 @@
+from .migration import make_migrations, apply_migrations, reset_db
+from .generalcommands import show_apps, runserver, startapp
+
+def handle_command(command, app_name=None):
+    if command == "makemigrations": make_migrations()
+    elif command == "migrate": apply_migrations()
+    elif command == "reset_db": reset_db()
+    elif command == "show_apps": show_apps()
+    elif command == "runserver": runserver()
+    elif command=="startapp": startapp(app_name)
+    else: print(f"Unknown command: {command}")          
+

mvcfw-0.1.0/fwfiles/ORM/db.py

@@ -0,0 +1,13 @@
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker, declarative_base
+
+Base = declarative_base()
+
+class DBconnection:
+    def __init__(self, url="sqlite:///db.sqlite3", echo=True):
+        self.engine = create_engine(url, echo=echo)
+        self.Session = sessionmaker(bind=self.engine)
+        self.session = self.Session()
+
+    def create_tables(self):
+        Base.metadata.create_all(self.engine)

mvcfw-0.1.0/fwfiles/ORM/feilds.py

@@ -0,0 +1,40 @@
+from sqlalchemy import Column, Integer, String, Float, Boolean, Text, Date, DateTime, Time
+from sqlalchemy.dialects.mysql import LONGTEXT
+from datetime import datetime
+
+
+def IntegerField(primary_key=False, null=False, increment=False):
+    return Column(Integer, primary_key=primary_key, nullable=null,autoincrement=increment)
+
+def CharField(max_length=255, null=False):
+    return Column(String(max_length), nullable=null)
+
+def FloatField(null=False):
+    return Column(Float, nullable=null)
+
+def BooleanField(default=False, null=False):
+    return Column(Boolean, default=default, nullable=null)
+
+def TextField(long=False, null=False):
+    return Column(LONGTEXT if long else Text, nullable=null)
+
+def FileField(max_length=255, null=False): 
+    return Column(String(max_length), nullable=null)
+
+def DateField(auto_now=False, auto_now_add=False, null=False):
+    default = None
+    if auto_now or auto_now_add:
+        default = datetime.utcnow().date
+    return Column(Date, default=default, nullable=null)
+
+def DateTimeField(auto_now=False, auto_now_add=False, null=False):
+    default = None
+    if auto_now or auto_now_add:
+        default = datetime.utcnow
+    return Column(DateTime, default=default, nullable=null)
+
+def TimeField(auto_now=False, auto_now_add=False, null=False):
+    default = None
+    if auto_now or auto_now_add:
+        default = datetime.utcnow().time
+    return Column(Time, default=default, nullable=null)

mvcfw-0.1.0/fwfiles/ORM/generalcommands.py

@@ -0,0 +1,121 @@
+import os
+import sys
+import time
+import subprocess
+from watchdog.observers import Observer
+from watchdog.events import FileSystemEventHandler
+from fwfiles import projectcontext
+
+def show_apps():
+    config = projectcontext.get_config()
+    for i in config.INSTALLED_APPS:
+        print(i)
+
+def startapp(name):
+    if not name:
+        print("Usage: python manager.py startapp <app_name>")
+        return
+
+    if os.path.exists(name):
+        print(f"Error: App '{name}' already exists.")
+        return
+
+    os.makedirs(os.path.join(name,"views"))
+    os.makedirs(os.path.join("migrations",name))
+
+    files={
+        "__init__.py":"",
+        "models.py":"",
+        "controller.py":"""from .views import index
+
+def start(req):
+    return index.Index
+""",
+        "router.py":"""from . import controller
+
+ROUTING={
+    "index":controller.start
+}
+""",
+        os.path.join("views","__init__.py"):"from . import index\n",
+        os.path.join("views","index.py"):'''import customtkinter as ctk
+
+class Index(ctk.CTkFrame):
+    def __init__(self,master,data=None,**kwargs):
+        super().__init__(master,**kwargs)
+        ctk.CTkLabel(self,text="Welcome",font=("Arial",24,"bold")).pack(pady=40)
+'''
+    }
+
+    for path,content in files.items():
+        with open(os.path.join(name,path),"w",encoding="utf-8") as f:
+            f.write(content)
+
+    config=projectcontext.get_config()
+
+    if name not in config.INSTALLED_APPS:
+        config.INSTALLED_APPS.append(name)
+
+    config_path=config.__file__
+
+    with open(config_path,"w",encoding="utf-8") as f:
+        f.write(f"INSTALLED_APPS={config.INSTALLED_APPS!r}\n\n")
+        f.write(f"THEME={config.THEME!r}\n\n")
+        f.write(f"DATABASE={config.DATABASE!r}\n")
+
+    print(f"App '{name}' created successfully.")
+
+
+
+class RunServer:
+    def __init__(self, project_dir=None, entry_script="run.py"):
+        self.project_dir = project_dir or os.getcwd()
+        self.entry_script = entry_script
+        self.process = None
+
+    def start_process(self):
+        if self.process:
+            self.process.kill()
+            self.process.wait()
+        print(f"Starting {self.entry_script} ...")
+        self.process = subprocess.Popen([sys.executable, self.entry_script])
+
+    def on_any_event(self, event):
+        if event.src_path.endswith(".py"):
+            print(f"[Hot-Reload] Change detected: {event.src_path}")
+            self.start_process()
+
+    def run(self):
+        from watchdog.observers import Observer
+        from watchdog.events import FileSystemEventHandler
+
+        class Handler(FileSystemEventHandler):
+            def __init__(self, server):
+                self.server = server
+            def on_any_event(self, event):
+                self.server.on_any_event(event)
+
+        # Start observer
+        handler = Handler(self)
+        observer = Observer()
+        observer.schedule(handler, self.project_dir, recursive=True)
+        observer.start()
+
+        # Start initial process
+        self.start_process()
+        print(f"Watching {self.project_dir} for changes...")
+
+        try:
+            while True:
+                time.sleep(1)
+        except KeyboardInterrupt:
+            observer.stop()
+            if self.process:
+                self.process.kill()
+        observer.join()
+
+
+# ----------------- Command line entry -----------------
+def runserver():
+    server = RunServer()
+    server.run()