• Table of Contents;
• About;
• Requirements;
• Running;
  • Server;
  • Client.

This is a self-educational project created only for sake of trying to build a simple CRUD project using the Flask framework.

It consists of the two parts:

• Server;
• Client.

Server runs a RESTful API and SSR web-app.

Client, in turn, provides a simple terminal-based access to the RESTful API provided by the server.

• Python 3.12;
• Flask 3.0.x (for server);
• Requests 2.x.x (for client).

Exact versions used in development are specified in the requirements.txt.

To run server or client you must firstly set your working directory to the src. When you are ready, proceed to the following sections.

To run server with the default options simply execute the following command in your terminal:

python3 -m server

You can additionaly pass a one or more arguments to the server. The following table contains a list of available options with their default values and description.

To run client with the default options simply execute the following command in your terminal:

python3 -m client

You can additionaly pass a one or more arguments to the client. The following table contains a list of available options with their default values and description.