https://github.com/touch-callable/touch-callable

Automatically generate a Web UI for Python function using type annotations.
https://github.com/touch-callable/touch-callable

callable dashboard easy-to-use function python3 react serverless type-annotations type-hint ui web

Last synced: 7 days ago
JSON representation

Automatically generate a Web UI for Python function using type annotations.

• Host: GitHub
• URL: https://github.com/touch-callable/touch-callable
• Owner: touch-callable
• License: mit
• Created: 2019-10-19T19:16:20.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T12:33:50.000Z (almost 2 years ago)
• Last Synced: 2024-09-14T21:21:09.696Z (2 months ago)
• Topics: callable, dashboard, easy-to-use, function, python3, react, serverless, type-annotations, type-hint, ui, web
• Language: JavaScript
• Homepage:
• Size: 3.48 MB
• Stars: 40
• Watchers: 3
• Forks: 3
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



Touch-Callable



  

  





The web framework for less serious application.

Automatically generate a Web UI for Python function using type annotations.



English | [简体中文](./README_zh_CN.md)

## Support platforms

- macOS

- Ubuntu

- Windows

## Installation

Only support Python 3.6!

`pip install -U touch-callable`

## Supported parameter value types

- str

- int

- float

- bool

- datetime.datetime

- datetime.date

- datetime.time

- enum.Enum

- io.BytesIO

- typing.BinaryIO

## Supported return value types

- All objects that can be `json.dumps`

- `open('filename.xxx', 'rb')`, return values' annotation should be `io.BufferedReader`

## CommandLine args

#### `--host` 

Default is 127.0.0.1, you can only visit it on your computer.

If you want to listen all networks：

`$ touch-callable example.py --host 0.0.0.0`

#### `--port` 

Default is 6789.

#### `--debug` enable Flask debug feature(not recommend)

Default is False, if you want to enable it

`$ touch-callable example.py --debug True`

## Screenshot

#### callables

![callables](https://raw.githubusercontent.com/pengwk/touch-callable/master/callables_en_us.png)

## Examples

### All support types

```python

# example.py

from datetime import datetime, date, time

from enum import Enum

import io

import typing

class Languages(Enum):

    Python = 'Python'

    PHP = 'PHP'

    Java = 'Java'

def demo(int_: int, str_: str, float_: float, bool_: bool,

         enum_: Languages,

         datetime_: datetime = datetime.now(),

         date_: date = date.today(),

         time_: time = time(1, 2, 3),

         bytes_io: io.BytesIO = None,

         binary_io: typing.BinaryIO = None):

    pass

```

`$ touch-callable example.py`

![demo_with_reponsive_ui](https://raw.githubusercontent.com/pengwk/touch-callable/master/demo_all_args_with_responsive_ui_en_us.png)

### Return file

```python

import io

def return_file() -> io.BufferedReader:

  return open('filename', 'rb')

```

## Stargazers

[![Stargazers over time](https://starchart.cc/pengwk/touch-callable.svg)](https://starchart.cc/pengwk/touch-callable)