Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/offerrall/functogui
Easily turn your Python functions into GUI applications
https://github.com/offerrall/functogui
gui kivy python typer ui
Last synced: about 6 hours ago
JSON representation
Easily turn your Python functions into GUI applications
- Host: GitHub
- URL: https://github.com/offerrall/functogui
- Owner: offerrall
- License: mit
- Created: 2025-01-03T15:34:24.000Z (14 days ago)
- Default Branch: main
- Last Pushed: 2025-01-17T17:48:24.000Z (about 8 hours ago)
- Last Synced: 2025-01-17T18:46:30.191Z (about 7 hours ago)
- Topics: gui, kivy, python, typer, ui
- Language: Python
- Homepage:
- Size: 1 MB
- Stars: 64
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
**Easily turn your Python functions into GUI applications.**
Perfect for internal tools, quick testing, or prototypes. FuncToGUI is cross-platform, updates in real-time, and requires no additional UI code. Implemented in fewer than 1000 lines of code!
FuncToGUI is built on top of [Kivy](https://kivy.org/) and [pyler](https://github.com/kivy/plyer) for file handling.
## Quick Start
Normal function (no data limits):
```python
from functogui import App
def is_even(number: int = 4) -> bool:
return number % 2 == 0
App(is_even)
```
Function with UI types (limits the input data):
```python
from functogui import App, intUi, intReturn
from typing import Annotated
def time_to_seconds(hours: Annotated[int, intUi(max_value=24)] = 1,
minutes: Annotated[int, intUi(max_value=59)] = 30
) -> int:
return (hours * 3600) + (minutes * 60)
App(time_to_seconds)
```
## Key Features
- **Function-to-GUI Transformation**: Turn your function parameters into a GUI interface with minimal setup.
- **No Complex Configuration**: Just define your function with the desired [`ui_types`](./functogui/ui_types.py) and let FuncToGUI generate the window.
- **Supports Various Parameter Types**:
- `intUi`
- `boolUi`
- `strUi`
- `listUi`
- `floatUi`
- `fileUi`
- `folderUi`
- `colorUi`
- **Supports Various Return Types**:
- `boolReturn`
- `intReturn`
- `strReturn`
- `floatReturn`
- `imageFileReturn`
- **Easily Extensible**: You can create your own UI types if you need something more specific.
## Installation
```bash
git clone https://github.com/offerrall/FuncToGUI
cd FuncToGUI
pip install .
```
## How to Use
This library is designed to be as simple as possible. You only need look at the examples to understand how to use it.
- [Examples](./examples)
## Documentation
**`functogui.ui_types`**
- Define input types: `strUi`, `intUi`, `boolUi`, `fileUi`
- Define return types: `strReturn`, `intReturn`, `boolReturn`, `imageFileReturn`
**`functogui.inspect_function`**
- Extracts function signature and annotations
- Validates function parameters and return types
**`functogui.ui_widgets`**
- Custom Kivy widgets for each UI type
- Handle user input and validation
- Manage real-time callback updates
**`functogui.app_builder`**
- Creates dynamic GUI layout
- Manages window properties
- Handles function execution and result display
**`functogui.styles`**
- Contains all the styles for the GUI
## Roadmap
### Core Features
- [ ] More parameter types (dateUi, timeUi, etc.)
- [ ] More return types (plotReturn, jsonReturn, etc.)
- [ ] Custom themes and styling through App class
- [ ] Improved error handling
- [ ] Better control widgets (sliders, dropdowns, etc.)
- [ ] Better return widgets (images, plots, etc.)
### Platform Support
- [ ] iOS compatibility testing
- [ ] Android compatibility testing
- [ ] MacOS compatibility testing
- [X] Windows compatibility testing
- [ ] Linux compatibility testing
## Community & Contributing
Join our Discord community to: [Discord](https://discord.gg/4yUxMCK3)
- Discuss the project
- Get help and ask questions
- Share ideas and suggestions
- Contribute to development
- Connect with other users
We welcome contributions! Whether you want to fix bugs, add features, or improve documentation - hop into Discord and let's collaborate.