modelit 0.2.4__tar.gz → 0.2.6__tar.gz

{modelit-0.2.4 → modelit-0.2.6}/CONTRIBUTING.md

@@ -17,6 +17,8 @@ modelit/templates/<name>/
 modelit/templates/<name>/template.py
 ```
 
+For multi-file templates, add more files in the same folder.
+
 4. Make sure the folder name is the function name.
 5. Test it locally:
 
@@ -39,6 +41,7 @@ modelit create <name>
 - Do not add `metadata.json`.
 - Keep file names lowercase.
 - Prefer clean, beginner-friendly code.
+- If a template has multiple files, `--output` should be treated as a directory.
 
 ## Pull request flow
 

modelit-0.2.6/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include modelit/templates *.py *.java *.json

{modelit-0.2.4 → modelit-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modelit
-Version: 0.2.4
+Version: 0.2.6
 Summary: Local-first ML starter templates you can print or save
 Author: Yashsmith
 License-Expression: MIT
@@ -28,6 +28,8 @@ ModelIt is a tiny Python package for storing your ML/DL boilerplate templates.
 - `perceptron()` prints the full code
 - `perceptron(output="code1.py")` saves it to a file
 - `modelit create perceptron` works from the terminal
+- single-file templates write to a file
+- multi-file templates write to a folder
 
 ## Install
 
@@ -86,8 +88,16 @@ modelit/templates/mycode/
 modelit/templates/mycode/template.py
 ```
 
+For Java, use:
+
+```text
+modelit/templates/mycode/template.java
+```
+
 3. Done. The folder name becomes the function name.
 
+If a template has more than one file, `--output` must be a directory path.
+
 That means this will work automatically:
 
 ```python
@@ -103,6 +113,12 @@ modelit create mycode
 modelit create mycode --output mycode.py
 ```
 
+For multi-file templates:
+
+```bash
+modelit create solid_notification --output out/solid_notification
+```
+
 ## Publish flow
 
 1. Add a new template folder.

{modelit-0.2.4 → modelit-0.2.6}/README.md

@@ -8,6 +8,8 @@ ModelIt is a tiny Python package for storing your ML/DL boilerplate templates.
 - `perceptron()` prints the full code
 - `perceptron(output="code1.py")` saves it to a file
 - `modelit create perceptron` works from the terminal
+- single-file templates write to a file
+- multi-file templates write to a folder
 
 ## Install
 
@@ -66,8 +68,16 @@ modelit/templates/mycode/
 modelit/templates/mycode/template.py
 ```
 
+For Java, use:
+
+```text
+modelit/templates/mycode/template.java
+```
+
 3. Done. The folder name becomes the function name.
 
+If a template has more than one file, `--output` must be a directory path.
+
 That means this will work automatically:
 
 ```python
@@ -83,6 +93,12 @@ modelit create mycode
 modelit create mycode --output mycode.py
 ```
 
+For multi-file templates:
+
+```bash
+modelit create solid_notification --output out/solid_notification
+```
+
 ## Publish flow
 
 1. Add a new template folder.

{modelit-0.2.4 → modelit-0.2.6}/modelit/cli.py

@@ -17,7 +17,7 @@ def main(argv: list[str] | None = None) -> None:
 
     create_parser = subparsers.add_parser("create", help="Print or save a template")
     create_parser.add_argument("name", choices=available_models(), help="Template name")
-    create_parser.add_argument("-o", "--output", help="Write the template to a file instead of printing")
+    create_parser.add_argument("-o", "--output", help="Write to a file for single-file templates or a directory for multi-file templates")
     create_parser.set_defaults(func=_create)
 
     args = parser.parse_args(argv)

modelit-0.2.6/modelit/registry.py

@@ -0,0 +1,92 @@
+"""Template discovery and loading."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from importlib.resources import files
+from pathlib import Path
+
+PACKAGE_NAME = "modelit"
+TEMPLATES_DIR = "templates"
+
+@dataclass(frozen=True)
+class TemplateInfo:
+    name: str
+
+def _templates_root():
+    return files(PACKAGE_NAME).joinpath(TEMPLATES_DIR)
+
+def _template_dir(name: str):
+    return _templates_root().joinpath(name)
+
+def available_models() -> tuple[str, ...]:
+    root = _templates_root()
+    if not root.is_dir():
+        return ()
+
+    names: list[str] = []
+    for child in root.iterdir():
+        if child.is_dir() and not child.name.startswith("__"):
+            if any(child.iterdir()):
+                names.append(child.name)
+    return tuple(sorted(names))
+
+def load_metadata(name: str) -> TemplateInfo:
+    return TemplateInfo(name=name)
+
+def load_template_files(name: str) -> dict[str, str]:
+    target_dir = _template_dir(name)
+    if not target_dir.is_dir():
+        raise FileNotFoundError(f"Missing template directory for {name!r}")
+        
+    file_contents = {}
+    for child in target_dir.iterdir():
+        if child.is_file() and not child.name.startswith("__"):
+            file_contents[child.name] = child.read_text(encoding="utf-8")
+    return file_contents
+
+def build_template_callable(name: str):
+    files_dict = load_template_files(name)
+    info = load_metadata(name)
+
+    is_single_file = len(files_dict) == 1
+    default_filename = list(files_dict.keys())[0] if is_single_file else name
+
+    def runner(output: str | None = None) -> None:
+        if output:
+            out_path = Path(output)
+
+            if is_single_file:
+                if out_path.exists():
+                    raise FileExistsError(f"Output path already exists: {out_path}")
+                out_path.parent.mkdir(parents=True, exist_ok=True)
+                out_path.write_text(list(files_dict.values())[0], encoding="utf-8")
+                print(f"Generated {out_path}")
+            else:
+                if out_path.suffix:
+                    raise ValueError("Multi-file templates require a directory output path")
+                if out_path.exists() and not out_path.is_dir():
+                    raise FileExistsError(f"Output path already exists and is not a directory: {out_path}")
+                out_path.mkdir(parents=True, exist_ok=True)
+                for fname, content in files_dict.items():
+                    file_path = out_path / fname
+                    if file_path.exists():
+                        print(f"Skipping {file_path} (already exists)")
+                        continue
+                    file_path.write_text(content, encoding="utf-8")
+                    print(f"Generated {file_path}")
+            return None
+
+        # If no output is specified, print to terminal
+        for fname, content in files_dict.items():
+            if not is_single_file:
+                print(f"\n{'='*40}\nFile: {fname}\n{'='*40}")
+            print(content, end="\n\n" if not is_single_file else "")
+
+    runner.__name__ = name
+    runner.__qualname__ = name
+    runner.__module__ = "modelit"
+    runner.__doc__ = f"Print or save the {name} template."
+    runner.output_file = default_filename  # type: ignore[attr-defined]
+    runner.template_info = info  # type: ignore[attr-defined]
+    return runner

modelit-0.2.6/modelit/templates/abstract_factory_pattern/template.java

@@ -0,0 +1,44 @@
+interface Button { void render(); }
+interface Checkbox { void render(); }
+
+class WinButton implements Button {
+    public void render() { System.out.println("Rendering Windows Button"); }
+}
+class MacButton implements Button {
+    public void render() { System.out.println("Rendering macOS Button"); }
+}
+
+class WinCheckbox implements Checkbox {
+    public void render() { System.out.println("Rendering Windows Checkbox"); }
+}
+class MacCheckbox implements Checkbox {
+    public void render() { System.out.println("Rendering macOS Checkbox"); }
+}
+
+interface GUIFactory {
+    Button createButton();
+    Checkbox createCheckbox();
+}
+
+class WindowsFactory implements GUIFactory {
+    public Button createButton() { return new WinButton(); }
+    public Checkbox createCheckbox() { return new WinCheckbox(); }
+}
+
+class MacOSFactory implements GUIFactory {
+    public Button createButton() { return new MacButton(); }
+    public Checkbox createCheckbox() { return new MacCheckbox(); }
+}
+
+public class AbstractFactoryDemo {
+    public static void main(String[] args) {
+        String os = "Mac"; 
+        GUIFactory factory = os.equals("Mac") ? new MacOSFactory() : new WindowsFactory();
+        
+        Button button = factory.createButton();
+        Checkbox checkbox = factory.createCheckbox();
+        
+        button.render();
+        checkbox.render();
+    }
+}

modelit-0.2.6/modelit/templates/adapter_pattern/template.java

@@ -0,0 +1,25 @@
+interface PaymentProcessor {
+    void processPayment(double amount);
+}
+
+class StripeService {
+    public void makePayment(double amountInCents) {
+        System.out.println("Stripe: Processing payment of " + amountInCents + " cents successfully.");
+    }
+}
+
+class StripeAdapter implements PaymentProcessor {
+    private StripeService stripeService = new StripeService();
+
+    public void processPayment(double amount) {
+        double amountInCents = amount * 100;
+        stripeService.makePayment(amountInCents);
+    }
+}
+
+public class AdapterDemo {
+    public static void main(String[] args) {
+        PaymentProcessor processor = new StripeAdapter();
+        processor.processPayment(50.00); 
+    }
+}

modelit-0.2.6/modelit/templates/advanced_exceptions/template.java

@@ -0,0 +1,42 @@
+import java.io.BufferedReader;
+import java.io.FileReader;
+import java.io.IOException;
+
+class InsufficientFundsException extends Exception {
+    public InsufficientFundsException(String message) {
+        super(message);
+    }
+}
+
+public class AdvancedExceptionDemo {
+    
+    public static void processTransfer(int accountBalance, int transferAmount) throws InsufficientFundsException {
+        if (transferAmount > accountBalance) {
+            throw new InsufficientFundsException("Transfer failed: Attempted to send $" + transferAmount + " but balance is $" + accountBalance);
+        }
+        System.out.println("Transfer of $" + transferAmount + " completed successfully.");
+    }
+
+    public static void main(String[] args) {
+        try {
+            processTransfer(5000, 7500);
+        } catch (InsufficientFundsException e) {
+            System.err.println("Business Error: " + e.getMessage());
+        }
+
+        System.out.println("-----------------");
+
+        String filePath = "non_existent_transactions.csv";
+        
+        try (BufferedReader reader = new BufferedReader(new FileReader(filePath))) {
+            System.out.println(reader.readLine());
+            int value = Integer.parseInt("Not_A_Number"); 
+            
+        } catch (IOException | NumberFormatException e) {
+            System.err.println("System Failure: Could not process file or format was corrupted.");
+            System.err.println("Root Cause: " + e.getClass().getSimpleName() + " -> " + e.getMessage());
+        } finally {
+            System.out.println("Cleanup executed. System remains stable.");
+        }
+    }
+}

modelit-0.2.6/modelit/templates/assertions/template.java

@@ -0,0 +1,19 @@
+class DiscountCalculator {
+    public static double applyDiscount(double originalPrice, double discountPercentage) {
+        double discountAmount = originalPrice * (discountPercentage / 100);
+        double finalPrice = originalPrice - discountAmount;
+        
+        assert finalPrice >= 0 : "CRITICAL LOGIC ERROR: Final price fell below zero!";
+        
+        return finalPrice;
+    }
+}
+
+public class AssertionDemo {
+    public static void main(String[] args) {
+        System.out.println("Final Price: $" + DiscountCalculator.applyDiscount(1000, 20));
+        
+        System.out.println("Testing invalid logic...");
+        System.out.println("Final Price: $" + DiscountCalculator.applyDiscount(500, 150)); 
+    }
+}

modelit-0.2.6/modelit/templates/bridge_pattern/template.java

@@ -0,0 +1,54 @@
+interface Device {
+    void turnOn();
+    void turnOff();
+    void setVolume(int percent);
+}
+
+class SmartTV implements Device {
+    private int volume = 30;
+    public void turnOn() { System.out.println("Smart TV is ON"); }
+    public void turnOff() { System.out.println("Smart TV is OFF"); }
+    public void setVolume(int percent) { 
+        volume = percent; 
+        System.out.println("Smart TV Volume set to " + volume); 
+    }
+}
+
+abstract class RemoteControl {
+    protected Device device;
+    public RemoteControl(Device device) { this.device = device; }
+    public abstract void togglePower();
+}
+
+class BasicRemote extends RemoteControl {
+    public BasicRemote(Device device) { super(device); }
+    public void togglePower() {
+        System.out.println("\n[Basic Remote Used]");
+        device.turnOn();
+    }
+}
+
+class AdvancedRemote extends RemoteControl {
+    public AdvancedRemote(Device device) { super(device); }
+    public void togglePower() {
+        System.out.println("\n[Advanced Remote Used]");
+        device.turnOn();
+    }
+    public void mute() {
+        System.out.println("Muting Device...");
+        device.setVolume(0);
+    }
+}
+
+public class BridgeDemo {
+    public static void main(String[] args) {
+        Device tv = new SmartTV();
+        
+        BasicRemote basicRemote = new BasicRemote(tv);
+        basicRemote.togglePower();
+        
+        AdvancedRemote advancedRemote = new AdvancedRemote(tv);
+        advancedRemote.togglePower();
+        advancedRemote.mute();
+    }
+}

modelit-0.2.6/modelit/templates/builder_pattern/template.java

@@ -0,0 +1,58 @@
+class UserProfile {
+    private final String username; 
+    private final String email;    
+    private final int age;         
+    private final String phone;    
+
+    private UserProfile(Builder builder) {
+        this.username = builder.username;
+        this.email = builder.email;
+        this.age = builder.age;
+        this.phone = builder.phone;
+    }
+
+    public void showProfile() {
+        System.out.println("User: " + username + " | Email: " + email + " | Age: " + age + " | Phone: " + phone);
+    }
+
+    static class Builder {
+        private String username;
+        private String email;
+        private int age = 0; 
+        private String phone = "N/A";
+
+        public Builder(String username, String email) {
+            this.username = username;
+            this.email = email;
+        }
+
+        public Builder setAge(int age) {
+            this.age = age;
+            return this;
+        }
+
+        public Builder setPhone(String phone) {
+            this.phone = phone;
+            return this;
+        }
+
+        public UserProfile build() {
+            return new UserProfile(this);
+        }
+    }
+}
+
+public class BuilderDemo {
+    public static void main(String[] args) {
+        UserProfile user1 = new UserProfile.Builder("user", "user@example.com")
+                                           .setAge(21)
+                                           .build();
+        
+        UserProfile user2 = new UserProfile.Builder("admin_user", "admin@sys.com")
+                                           .setPhone("+91-9876543210")
+                                           .build();
+
+        user1.showProfile();
+        user2.showProfile();
+    }
+}

modelit-0.2.6/modelit/templates/command_pattern/template.java

@@ -0,0 +1,58 @@
+import java.util.Stack;
+
+class BankAccount {
+    private int balance = 1000;
+    public void deposit(int amount) {
+        balance += amount;
+        System.out.println("Deposited $" + amount + ". Current Balance: $" + balance);
+    }
+    public void withdraw(int amount) {
+        balance -= amount;
+        System.out.println("Withdrew $" + amount + ". Current Balance: $" + balance);
+    }
+}
+
+interface TransactionCommand {
+    void execute();
+    void undo();
+}
+
+class DepositCommand implements TransactionCommand {
+    private BankAccount account;
+    private int amount;
+    
+    public DepositCommand(BankAccount account, int amount) {
+        this.account = account;
+        this.amount = amount;
+    }
+    public void execute() { account.deposit(amount); }
+    public void undo() { account.withdraw(amount); }
+}
+
+class TransactionManager {
+    private Stack<TransactionCommand> history = new Stack<>();
+
+    public void executeTransaction(TransactionCommand command) {
+        command.execute();
+        history.push(command);
+    }
+    public void undoLastTransaction() {
+        if (!history.isEmpty()) {
+            System.out.print("Undoing last transaction... ");
+            TransactionCommand lastCommand = history.pop();
+            lastCommand.undo();
+        }
+    }
+}
+
+public class CommandDemo {
+    public static void main(String[] args) {
+        BankAccount myAccount = new BankAccount();
+        TransactionManager manager = new TransactionManager();
+
+        manager.executeTransaction(new DepositCommand(myAccount, 500));
+        manager.executeTransaction(new DepositCommand(myAccount, 200));
+        
+        manager.undoLastTransaction(); 
+    }
+}

modelit-0.2.6/modelit/templates/composite_pattern/template.java

@@ -0,0 +1,53 @@
+import java.util.ArrayList;
+import java.util.List;
+
+interface FileSystemComponent {
+    void showDetails();
+    int getSize();
+}
+
+class File implements FileSystemComponent {
+    private String name;
+    private int size;
+
+    public File(String name, int size) { this.name = name; this.size = size; }
+    public void showDetails() { System.out.println("   File: " + name + " (" + size + " KB)"); }
+    public int getSize() { return size; }
+}
+
+class Directory implements FileSystemComponent {
+    private String name;
+    private List<FileSystemComponent> components = new ArrayList<>();
+
+    public Directory(String name) { this.name = name; }
+    public void addComponent(FileSystemComponent component) { components.add(component); }
+
+    public void showDetails() {
+        System.out.println("Directory: " + name + " | Total Size: " + getSize() + " KB");
+        for (FileSystemComponent component : components) {
+            component.showDetails();
+        }
+    }
+
+    public int getSize() {
+        return components.stream().mapToInt(FileSystemComponent::getSize).sum();
+    }
+}
+
+public class CompositeDemo {
+    public static void main(String[] args) {
+        File file1 = new File("resume.pdf", 500);
+        File file2 = new File("photo.png", 1500);
+        File file3 = new File("system_config.txt", 15);
+
+        Directory personalDir = new Directory("Personal Files");
+        personalDir.addComponent(file1);
+        personalDir.addComponent(file2);
+
+        Directory rootDir = new Directory("Root");
+        rootDir.addComponent(personalDir);
+        rootDir.addComponent(file3);
+
+        rootDir.showDetails();
+    }
+}

modelit-0.2.6/modelit/templates/decorator_pattern/template.java

@@ -0,0 +1,39 @@
+interface Coffee {
+    String getDescription();
+    double getCost();
+}
+
+class Espresso implements Coffee {
+    public String getDescription() { return "Espresso"; }
+    public double getCost() { return 150.0; }
+}
+
+abstract class CoffeeDecorator implements Coffee {
+    protected Coffee decoratedCoffee;
+    public CoffeeDecorator(Coffee coffee) { this.decoratedCoffee = coffee; }
+    public String getDescription() { return decoratedCoffee.getDescription(); }
+    public double getCost() { return decoratedCoffee.getCost(); }
+}
+
+class MilkDecorator extends CoffeeDecorator {
+    public MilkDecorator(Coffee coffee) { super(coffee); }
+    public String getDescription() { return super.getDescription() + ", Steamed Milk"; }
+    public double getCost() { return super.getCost() + 30.0; }
+}
+
+class CaramelDecorator extends CoffeeDecorator {
+    public CaramelDecorator(Coffee coffee) { super(coffee); }
+    public String getDescription() { return super.getDescription() + ", Caramel Syrup"; }
+    public double getCost() { return super.getCost() + 45.0; }
+}
+
+public class DecoratorDemo {
+    public static void main(String[] args) {
+        Coffee myOrder = new Espresso();
+        myOrder = new MilkDecorator(myOrder);
+        myOrder = new CaramelDecorator(myOrder);
+
+        System.out.println("Order Details: " + myOrder.getDescription());
+        System.out.println("Total Cost: ₹" + myOrder.getCost());
+    }
+}