func-to-web 0.1.0__tar.gz

func_to_web-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2025 The Bootstrap Authors
+
+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.

func_to_web-0.1.0/PKG-INFO

@@ -0,0 +1,326 @@
+Metadata-Version: 2.4
+Name: func-to-web
+Version: 0.1.0
+Summary: Transform any Python function into a web interface automatically
+Author: Beltrán Offerrall
+Project-URL: Homepage, https://github.com/offerrall/FuncToWeb
+Project-URL: Repository, https://github.com/offerrall/FuncToWeb
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: pydantic
+Requires-Dist: jinja2
+Requires-Dist: python-multipart
+Dynamic: license-file
+
+# Func To Web
+
+**Transform any Python function into a web interface automatically.**
+
+func-to-web is a minimalist library that generates web UIs from your Python functions with zero boilerplate. Just add type hints, call `run()`, and you're done.
+
+**The entire library is just 350 lines of Python and 700 lines of HTML/CSS/JS.** Simple, powerful, and easy to understand.
+
+![func-to-web Demo](images/functoweb.jpg)
+
+## Quick Start (Minimal Example)
+
+```python
+from func_to_web import run
+
+def divide(a: int, b: int):
+    return a / b
+
+run(divide)
+```
+
+Open `http://127.0.0.1:8000` in your browser and you'll see an auto-generated form.
+
+![func-to-web Demo](images/demo.jpg)
+
+
+## Installation
+
+```bash
+git clone https://github.com/offerrall/FuncToWeb
+cd FuncToWeb
+pip install .
+```
+
+Or install directly from GitHub:
+
+```bash
+pip install git+https://github.com/offerrall/FuncToWeb.git
+```
+
+## Examples
+
+**Check the `examples/` folder** for 14+ complete, runnable examples covering everything from basic forms to image processing and data visualization. Each example is a single Python file you can run immediately:
+
+```bash
+python examples/01_basic_division.py
+python examples/08_image_blur.py
+python examples/11_plot_sine.py
+```
+
+![Examples Preview](images/full_example.jpeg)
+
+## What Can You Do?
+
+### Basic Types
+
+All Python built-in types work out of the box:
+
+```python
+from func_to_web import run
+from datetime import date, time
+
+def example(
+    text: str,              # Text input
+    number: int,            # Integer input
+    decimal: float,         # Decimal input
+    checkbox: bool,         # Checkbox
+    birthday: date,         # Date picker
+    meeting: time           # Time picker
+):
+    return "All basic types supported!"
+
+run(example)
+```
+
+![Basic Types](images/basic.jpg)
+
+### Special Input Types
+
+```python
+from func_to_web import run, Color, Email
+
+def special_inputs(
+    favorite_color: Color,  # Color picker
+    contact: Email          # Email validation
+):
+    return f"Color: {favorite_color}, Email: {contact}"
+
+run(special_inputs)
+```
+
+![Color Picker](images/color.jpg)
+
+### File Uploads
+
+```python
+from func_to_web import run, ImageFile, DataFile, TextFile, DocumentFile
+
+def process_files(
+    photo: ImageFile,       # .png, .jpg, .jpeg, .gif, .webp
+    data: DataFile,         # .csv, .xlsx, .xls, .json
+    notes: TextFile,        # .txt, .md, .log
+    report: DocumentFile,   # .pdf, .doc, .docx
+):
+    return "Files uploaded!"
+
+run(process_files)
+```
+
+![File Upload](images/files.jpg)
+
+### Dropdowns
+
+```python
+from typing import Literal
+from func_to_web import run
+
+def preferences(
+    theme: Literal['light', 'dark', 'auto'],
+    language: Literal['en', 'es', 'fr']
+):
+    return f"Theme: {theme}, Language: {language}"
+
+run(preferences)
+```
+
+![Dropdowns](images/drop.jpg)
+
+### Constraints & Validation
+
+```python
+from typing import Annotated
+from pydantic import Field
+from func_to_web import run
+
+def register(
+    age: Annotated[int, Field(ge=18, le=120)],              # Min/max values
+    username: Annotated[str, Field(min_length=3, max_length=20)],  # Length limits
+    rating: Annotated[float, Field(gt=0, lt=5)]             # Exclusive bounds
+):
+    return f"User {username}, age {age}, rating {rating}"
+
+run(register)
+```
+
+![Validation](images/limits.jpg)
+
+### Return Images & Plots
+
+func-to-web automatically detects and displays images from PIL/Pillow and matplotlib:
+
+```python
+from func_to_web import run, ImageFile
+from PIL import Image, ImageFilter
+
+def blur_image(image: ImageFile, radius: int = 5):
+    img = Image.open(image)
+    return img.filter(ImageFilter.GaussianBlur(radius))
+
+run(blur_image)
+```
+
+![Image Processing](images/image.jpg)
+
+```python
+from func_to_web import run
+import matplotlib.pyplot as plt
+import numpy as np
+
+def plot_sine(frequency: float = 1.0, amplitude: float = 1.0):
+    x = np.linspace(0, 10, 1000)
+    y = amplitude * np.sin(frequency * x)
+    
+    fig, ax = plt.subplots(figsize=(10, 6))
+    ax.plot(x, y)
+    ax.grid(True)
+    return fig
+
+run(plot_sine)
+```
+
+![Plot Result](images/plot.jpg)
+
+## Run Multiple Functions 
+
+You can serve multiple functions simultaneously. When passing a list of functions, func-to-web automatically creates a responsive index page where users can select the tool they want to use. This is demonstrated in Example 14.
+
+```python
+from func_to_web import run
+
+def calculate_bmi(weight_kg: float, height_m: float):
+    """Calculate Body Mass Index"""
+    bmi = weight_kg / (height_m ** 2)
+    return f"BMI: {bmi:.2f}"
+
+def celsius_to_fahrenheit(celsius: float):
+    """Convert Celsius to Fahrenheit"""
+    fahrenheit = (celsius * 9/5) + 32
+    return f"{celsius}°C = {fahrenheit}°F"
+
+def reverse_text(text: str):
+    """Reverse a string"""
+    return text[::-1]
+
+# Pass a list of functions to create an index page
+run([calculate_bmi, celsius_to_fahrenheit, reverse_text])
+```
+
+![Multiple Tools](images/multiple.jpg)
+
+## Features
+
+### Input Types
+- `int`, `float`, `str`, `bool` - Basic types
+- `date`, `time` - Date and time pickers
+- `Color` - Color picker with preview
+- `Email` - Email validation
+- `Literal[...]` - Dropdown selections
+- `ImageFile`, `DataFile`, `TextFile`, `DocumentFile` - File uploads
+
+### Validation
+- **Numeric**: `ge`, `le`, `gt`, `lt` (min/max bounds)
+- **String**: `min_length`, `max_length`, `pattern` (regex)
+- **Required/Optional**: Automatic detection from type hints
+- **Default values**: Set in function signature
+
+### Output Types
+- **Text/Numbers/Dicts** - Formatted as JSON
+- **PIL Images** - Displayed as images
+- **Matplotlib Figures** - Rendered as PNG
+- **Any object** - Converted with `str()`
+
+## Configuration
+
+### One function:
+```python
+from func_to_web import run
+
+def my_function(x: int):
+    return x * 2
+
+run(my_function, host="127.0.0.1", port=5000, template_dir="my_templates")
+```
+
+### Multiple functions:
+```python
+from func_to_web import run
+
+def func1(x: int): 
+    return x * 2
+
+def func2(y: str): 
+    return y.upper()
+
+run([func1, func2], host="127.0.0.1", port=5000, template_dir="my_templates")
+```
+
+**Parameters:**
+- `func_or_list` - Single function or list of functions to serve
+- `host` - Server host (default: `"0.0.0.0"`)
+- `port` - Server port (default: `8000`)
+- `template_dir` - Custom template directory (optional)
+
+## Why func-to-web?
+
+- **Minimalist** - Only 350 lines of Python + 700 lines of HTML/CSS/JS
+- **Zero boilerplate** - Just type hints and you're done
+- **Powerful** - Supports all common input types including files
+- **Smart output** - Automatically displays images, plots, and data
+- **Type-safe** - Full Pydantic validation
+- **Client + server validation** - Instant feedback and robust checks
+- **Batteries included** - 15+ examples in the `examples/` folder
+- **Multi-function support** - Serve multiple tools from one server
+
+## How It Works
+
+1. **Analysis** - Inspects function signature using `inspect`
+2. **Validation** - Validates type hints and constraints using `pydantic`
+3. **Form Generation** - Builds HTML form fields from metadata
+4. **File Handling** - Saves uploaded files to temp locations
+5. **Server** - Runs FastAPI server with auto-generated routes
+6. **Result Processing** - Detects return type and formats accordingly
+7. **Display** - Shows results as text, JSON, images, or plots
+
+## Requirements
+
+- Python 3.12+
+- FastAPI
+- Uvicorn
+- Pydantic
+- Jinja2
+- python-multipart
+
+Optional for examples:
+- Pillow (for image processing)
+- Matplotlib (for plots)
+- NumPy (for numerical computations)
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Author
+
+Beltrán Offerrall

func_to_web-0.1.0/README.md

@@ -0,0 +1,309 @@
+# Func To Web
+
+**Transform any Python function into a web interface automatically.**
+
+func-to-web is a minimalist library that generates web UIs from your Python functions with zero boilerplate. Just add type hints, call `run()`, and you're done.
+
+**The entire library is just 350 lines of Python and 700 lines of HTML/CSS/JS.** Simple, powerful, and easy to understand.
+
+![func-to-web Demo](images/functoweb.jpg)
+
+## Quick Start (Minimal Example)
+
+```python
+from func_to_web import run
+
+def divide(a: int, b: int):
+    return a / b
+
+run(divide)
+```
+
+Open `http://127.0.0.1:8000` in your browser and you'll see an auto-generated form.
+
+![func-to-web Demo](images/demo.jpg)
+
+
+## Installation
+
+```bash
+git clone https://github.com/offerrall/FuncToWeb
+cd FuncToWeb
+pip install .
+```
+
+Or install directly from GitHub:
+
+```bash
+pip install git+https://github.com/offerrall/FuncToWeb.git
+```
+
+## Examples
+
+**Check the `examples/` folder** for 14+ complete, runnable examples covering everything from basic forms to image processing and data visualization. Each example is a single Python file you can run immediately:
+
+```bash
+python examples/01_basic_division.py
+python examples/08_image_blur.py
+python examples/11_plot_sine.py
+```
+
+![Examples Preview](images/full_example.jpeg)
+
+## What Can You Do?
+
+### Basic Types
+
+All Python built-in types work out of the box:
+
+```python
+from func_to_web import run
+from datetime import date, time
+
+def example(
+    text: str,              # Text input
+    number: int,            # Integer input
+    decimal: float,         # Decimal input
+    checkbox: bool,         # Checkbox
+    birthday: date,         # Date picker
+    meeting: time           # Time picker
+):
+    return "All basic types supported!"
+
+run(example)
+```
+
+![Basic Types](images/basic.jpg)
+
+### Special Input Types
+
+```python
+from func_to_web import run, Color, Email
+
+def special_inputs(
+    favorite_color: Color,  # Color picker
+    contact: Email          # Email validation
+):
+    return f"Color: {favorite_color}, Email: {contact}"
+
+run(special_inputs)
+```
+
+![Color Picker](images/color.jpg)
+
+### File Uploads
+
+```python
+from func_to_web import run, ImageFile, DataFile, TextFile, DocumentFile
+
+def process_files(
+    photo: ImageFile,       # .png, .jpg, .jpeg, .gif, .webp
+    data: DataFile,         # .csv, .xlsx, .xls, .json
+    notes: TextFile,        # .txt, .md, .log
+    report: DocumentFile,   # .pdf, .doc, .docx
+):
+    return "Files uploaded!"
+
+run(process_files)
+```
+
+![File Upload](images/files.jpg)
+
+### Dropdowns
+
+```python
+from typing import Literal
+from func_to_web import run
+
+def preferences(
+    theme: Literal['light', 'dark', 'auto'],
+    language: Literal['en', 'es', 'fr']
+):
+    return f"Theme: {theme}, Language: {language}"
+
+run(preferences)
+```
+
+![Dropdowns](images/drop.jpg)
+
+### Constraints & Validation
+
+```python
+from typing import Annotated
+from pydantic import Field
+from func_to_web import run
+
+def register(
+    age: Annotated[int, Field(ge=18, le=120)],              # Min/max values
+    username: Annotated[str, Field(min_length=3, max_length=20)],  # Length limits
+    rating: Annotated[float, Field(gt=0, lt=5)]             # Exclusive bounds
+):
+    return f"User {username}, age {age}, rating {rating}"
+
+run(register)
+```
+
+![Validation](images/limits.jpg)
+
+### Return Images & Plots
+
+func-to-web automatically detects and displays images from PIL/Pillow and matplotlib:
+
+```python
+from func_to_web import run, ImageFile
+from PIL import Image, ImageFilter
+
+def blur_image(image: ImageFile, radius: int = 5):
+    img = Image.open(image)
+    return img.filter(ImageFilter.GaussianBlur(radius))
+
+run(blur_image)
+```
+
+![Image Processing](images/image.jpg)
+
+```python
+from func_to_web import run
+import matplotlib.pyplot as plt
+import numpy as np
+
+def plot_sine(frequency: float = 1.0, amplitude: float = 1.0):
+    x = np.linspace(0, 10, 1000)
+    y = amplitude * np.sin(frequency * x)
+    
+    fig, ax = plt.subplots(figsize=(10, 6))
+    ax.plot(x, y)
+    ax.grid(True)
+    return fig
+
+run(plot_sine)
+```
+
+![Plot Result](images/plot.jpg)
+
+## Run Multiple Functions 
+
+You can serve multiple functions simultaneously. When passing a list of functions, func-to-web automatically creates a responsive index page where users can select the tool they want to use. This is demonstrated in Example 14.
+
+```python
+from func_to_web import run
+
+def calculate_bmi(weight_kg: float, height_m: float):
+    """Calculate Body Mass Index"""
+    bmi = weight_kg / (height_m ** 2)
+    return f"BMI: {bmi:.2f}"
+
+def celsius_to_fahrenheit(celsius: float):
+    """Convert Celsius to Fahrenheit"""
+    fahrenheit = (celsius * 9/5) + 32
+    return f"{celsius}°C = {fahrenheit}°F"
+
+def reverse_text(text: str):
+    """Reverse a string"""
+    return text[::-1]
+
+# Pass a list of functions to create an index page
+run([calculate_bmi, celsius_to_fahrenheit, reverse_text])
+```
+
+![Multiple Tools](images/multiple.jpg)
+
+## Features
+
+### Input Types
+- `int`, `float`, `str`, `bool` - Basic types
+- `date`, `time` - Date and time pickers
+- `Color` - Color picker with preview
+- `Email` - Email validation
+- `Literal[...]` - Dropdown selections
+- `ImageFile`, `DataFile`, `TextFile`, `DocumentFile` - File uploads
+
+### Validation
+- **Numeric**: `ge`, `le`, `gt`, `lt` (min/max bounds)
+- **String**: `min_length`, `max_length`, `pattern` (regex)
+- **Required/Optional**: Automatic detection from type hints
+- **Default values**: Set in function signature
+
+### Output Types
+- **Text/Numbers/Dicts** - Formatted as JSON
+- **PIL Images** - Displayed as images
+- **Matplotlib Figures** - Rendered as PNG
+- **Any object** - Converted with `str()`
+
+## Configuration
+
+### One function:
+```python
+from func_to_web import run
+
+def my_function(x: int):
+    return x * 2
+
+run(my_function, host="127.0.0.1", port=5000, template_dir="my_templates")
+```
+
+### Multiple functions:
+```python
+from func_to_web import run
+
+def func1(x: int): 
+    return x * 2
+
+def func2(y: str): 
+    return y.upper()
+
+run([func1, func2], host="127.0.0.1", port=5000, template_dir="my_templates")
+```
+
+**Parameters:**
+- `func_or_list` - Single function or list of functions to serve
+- `host` - Server host (default: `"0.0.0.0"`)
+- `port` - Server port (default: `8000`)
+- `template_dir` - Custom template directory (optional)
+
+## Why func-to-web?
+
+- **Minimalist** - Only 350 lines of Python + 700 lines of HTML/CSS/JS
+- **Zero boilerplate** - Just type hints and you're done
+- **Powerful** - Supports all common input types including files
+- **Smart output** - Automatically displays images, plots, and data
+- **Type-safe** - Full Pydantic validation
+- **Client + server validation** - Instant feedback and robust checks
+- **Batteries included** - 15+ examples in the `examples/` folder
+- **Multi-function support** - Serve multiple tools from one server
+
+## How It Works
+
+1. **Analysis** - Inspects function signature using `inspect`
+2. **Validation** - Validates type hints and constraints using `pydantic`
+3. **Form Generation** - Builds HTML form fields from metadata
+4. **File Handling** - Saves uploaded files to temp locations
+5. **Server** - Runs FastAPI server with auto-generated routes
+6. **Result Processing** - Detects return type and formats accordingly
+7. **Display** - Shows results as text, JSON, images, or plots
+
+## Requirements
+
+- Python 3.12+
+- FastAPI
+- Uvicorn
+- Pydantic
+- Jinja2
+- python-multipart
+
+Optional for examples:
+- Pillow (for image processing)
+- Matplotlib (for plots)
+- NumPy (for numerical computations)
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Author
+
+Beltrán Offerrall

func_to_web-0.1.0/examples/01_basic_division.py

@@ -0,0 +1,8 @@
+from func_to_web import run
+
+
+def divide(a: int, b: int):
+    """Simple division of two numbers"""
+    return a / b
+
+run(divide)

func_to_web-0.1.0/examples/02_validated_division.py

@@ -0,0 +1,11 @@
+from func_to_web import Annotated, Field, run
+
+
+def safe_divide(
+    numerator: int,
+    denominator: Annotated[int, Field(ge=1)]
+):
+    """Division that prevents divide by zero"""
+    return numerator / denominator
+
+run(safe_divide)

func_to_web-0.1.0/examples/03_all_basic_types.py

@@ -0,0 +1,24 @@
+from datetime import date, time
+
+from func_to_web import run
+
+
+def showcase_types(
+    name: str = "John",
+    age: int = 25,
+    height: float = 1.75,
+    active: bool = True,
+    birthday: date = date(2000, 1, 1),
+    alarm: time = time(7, 30)
+):
+    """Demonstrates all basic types"""
+    return {
+        "name": name,
+        "age": age,
+        "height": height,
+        "active": active,
+        "birthday": str(birthday),
+        "alarm": str(alarm)
+    }
+
+run(showcase_types)

func_to_web-0.1.0/examples/04_special_inputs.py

@@ -0,0 +1,12 @@
+from func_to_web import Color, Email, run
+
+
+def create_account(
+    email: Email,
+    favorite_color: Color = "#3b82f6",
+    secondary_color: Color = "#10b981"
+):
+    """Create account with special input types"""
+    return f"Account created for {email} with colors {favorite_color} and {secondary_color}"
+
+run(create_account)