autofront 0.1.1a3

Automatic front end for Python project

Autofront

Autofront is an automatic frontend for Python developers. In theory, any function or script can be run directly from a web browser on your local network. The function executes as normal and all print calls are displayed in the browser, along with any return value. Any input calls are redirected to the browser for user input.

This lets you run programs from your phone without needing to design a front-end. Autofront can become a simple remote control and display for a Raspeberry Pi project, a command center for your programs, a music player, anything you need.

The code has been kept simple in the hope that it can be used in schools teaching basic Python programming. All student programs can be gathered on one page and run from any student's phone anywhere in the school. The next alpha version should add support for remote access as well so they can do the same outside school.

Autofront's page design is basic and functional. If the project proves popular, different templates might be developed for specific project types. You can also create a custom template to suit your needs, or use custom CSS and Javascript. This requires basic knowledge of web design and Flask. Read the Flask docs for more information.

Wiki

Please consult the Autofront wiki for more detailed information on creating routes to functions and scripts. This readme only explains the basics.

Quickstart

Installing

Use pip:

pip install autofront

Autofront uses Flask to run the web server and will install it as a dependency if necessary. Since Autofront is still in alpha, it's recommended to install it in a virtual environment, if this is not already your usual procedure.

This link explains how to install packages and virtual environments.

Autofront requires Python 3.5 or higher and was developped on version 3.7. Compatibility with 3.5, 3.6 and 3.8 is still being tested.

Usage

Basic usage is simple. Create a new python file following this template:

import autofront
from my_module import my_function

autofront.create_route(my_function)

autofront.run()

• Create a new file.
• Import Autofront and your functions.
• Create routes to your functions.
• Start the server.

If your function or script needs arguments, route options are explained here.

A Flask server will launch at 0.0.0.0:5000. Access it from any browser on the same computer. You'll find a page with the name of your function and a "Go" button. Click it to run your function.

This is useful for development and gives you a simple web-based interface for your programs. But you can also easily access the server from your phone or another computer on the local network.

First, you need the local ip address of the computer running autofront. This step varies from system to system. On Mac or Linux, type the following command in the terminal:

ipconfig getifaddr en0

Here is the procedure for Windows 10

Enter your address and port in your browser in the following format:

ipaddress:port

For example:

192.168.0.179:5000

You can now run your functions and scripts from any browser connected to your local network.

Please consult the Autofront wiki for more detailed information on creating routes to functions and scripts.

Contributing

Autofront is open to outside contributors. As it's currently in alpha, the process is still to be determined.

Credits

Autofront was designed by Jean-Michel Laprise.