Website

class toui.apps.Website(name=None, assets_folder=None, secret_key=None)

Bases: _App

A class that creates a web application from HTML files.

Examples

Creating a web app:

>>> from toui import Website
>>> app = Website(__name__, secret_key="some key")

Creating a page and adding it to the app:

>>> from toui import Page
>>> home_page = Page(html_str="<h1>This is the home page</h1>")
>>> app.add_pages(home_page)

Running the app:

>>> if __name__ == "__main__":
...     app.run(debug=True) 

See also

toui.pages.Page, DesktopApp

Parameters:

• name (str (optional)) – The name of the app.

• assets_folder (str (optional)) – The path to the folder that contains the HTML files and other assets.

• secret_key (str (optional)) – Sets the secret_key attribute for flask.Flask. You can also set the environment variable SECRET_KEY from the command line and ToUI will get it using os.environ.

flask_app

ToUI creates applications using Flask. You can access the Flask object using the attribute flask_app.

Type:

Flask

forbidden_urls

These are URLs that ToUI does not allow the user to use because ToUI uses them.

Type:

list

user_vars

A dictionary that stores temporary data unique to each user. The data are stored in a Cache object from flask-caching package.

Type:

dict

pages

A list of added Page objects.

Type:

list

Warning

A folder called ‘flask_session’ will be created in the main directory when calling this class.

Behind The Scenes

ToUI uses Flask and its extenstions to create apps. When creating an instance of this class, the following extensions are used:

• Session class extension from Flask-Session package.

• Sock class extension from Flask-Sock package.

• Cache class extension from Flask-Caching package.

The following Flask configurations are also set:

• CACHE_TYPE = “SimpleCache”

• SESSION_TYPE = “filesystem”

Methods

toui.apps.Website.add_pages	Adds pages to the app.
toui.apps.Website.add_restriction	Makes the app private.
toui.apps.Website.add_user_database	Creates a simple database that has data specific to each user.
toui.apps.Website.download	Downloads a file from the server to a client.
toui.apps.Website.get_current_user	A static method that returns the current user.
toui.apps.Website.get_request	A static method that gets data sent from client using HTTP request.
toui.apps.Website.get_user_page	A static method that returns the current Page.
toui.apps.Website.open_new_page	Opens another URL.
toui.apps.Website.register_toui_blueprint	Registers a ToUIBlueprint object.
toui.apps.Website.run	Runs the application on a local development server.
toui.apps.Website.set_data_validation	Validate data received from JavaScript before using it.
toui.apps.Website.set_ws_validation	Validate simple_websocket.ws.Server object before sending and accepting data.
toui.apps.Website.signin_user	Loads the data of a user from database.
toui.apps.Website.signin_user_from_id	Loads the data of a user from database using the user's ID.
toui.apps.Website.signout_user	A method that signs out the current user.
toui.apps.Website.signup_user	Creates a new user in the database.
toui.apps.Website.username_exists	Checks if the username is exists in the database.