Introduction To Retica

Installing Retica

The easiest way to install Retica is to use the pip command line tool.

$~ pip install retica

Creating A Retica Server

Once you have installed Retica, you can import it into your Python environment. The server class is used to create a server, in which you can add endpoints(locations) and open HTTP(s) ports.

import Retica
retica = Retica.Server(__name__)

Creating An Endpoint

Endpoints are functions that are assigned to a location and are called when a request is made to that location.

@retica.create_endpoint("/hello/{name}")
def index(request: Retica.Request.request, response: Retica.Response.response, **data):
    response.body = f"Hello {data['name']}"

Creating A Socket

Sockets are used to create a server that listens for incoming connections. The server will listen on the specified port and host. Sockets can use 2 protocols:

  1. HTTP

  2. HTTPS (Certificate & key files are required)

  • You can also create your own protocols(In Development).

http_socket = Retica.Sockets.HTTP_Socket("localhost", 80)
https_socket = Retica.Sockets.HTTPS_Socket("localhost", 443, "cert.pem", "key.pem")

Running the Server

To run the server, you must call the run method on the server. An array of sockets should be passed in as an argument.

if __name__ == "__main__":
    retica.run([
        http_socket,
        https_socket
    ])

Boilerplate

This is the boilerplate code that you will need to create your own server.

import Retica
retica = Retica.Server(__name__)

@retica.create_endpoint("/hello/{name}")
def index(request: Retica.Request.request, response: Retica.Response.response, **data):
    response.body = f"Hello {data['name']}"

http_socket = Retica.Sockets.HTTP_Socket(Retica.Sockets.gethostname(), 80)

if __name__ == "__main__":
    retica.run([http_socket])