Kwik features
Kwik gives you the following features:
- FastAPI-based: all amazing FastAPI features are available, such as:
- Automatic interactive API documentation.
- Modern Python standards-based type hints.
- Automatic settings management from environment variables.
- Pydantic-based validation of settings.
- Database connections management via settings variables.
-
Dependency injection
- Automatic injection of database connections, with related transaction management.
- Automatic injection of user credentials in request-response cycle.
-
ORM support for Soft Delete pattern and automatic Audit.
- Authentication support with JWT (OAuth2.0 based).
- Permission and Roles management built-in.
Kwik
Documentation: https://kwik.rocks
Repository: https://github.com/dmezzogori/kwik
Kwik is a web framework for building modern, batteries-included, RESTful backends with Python 3.10+. Kwik is based on FastAPI, builds upon it and delivers an opinionated concise, business-oriented API.
The key features are:
- Conciseness: Kwik is quick (pun-intended
) - Battle-tested: developed internally at Kheperer, we use it every day to build robust and modern solutions for our customers.
- Standards-based
Warning
While Kwik is in active development, and already used for production, it is still in a pre-release state.
The API is subject to change, and the documentation is not complete yet.
Acknowledgments¶
Python 3.10+
Kwik stands on the shoulder of a couple of giants:
- FastAPI: for the web parts.
- SQLAlchemy: for the ORM part.
Installation¶
$ pip install kwik
+---> 100%
+Installed
+It will install kwik and all its dependencies.
Example¶
Run it¶
$ python -m kwik
+Uvicorn running on http://localhost:8080 (Press CTRL+C to quit)
+If kwik is started in this way, it automatically creates a development server on port 8080, with hot-reloading enabled
Check it¶
Open your browser at http://localhost:8080/docs.
You will see the automatic interactive API documentation, showing the built-in endpoints and schemas.
License¶
This project is licensed under the terms of the MIT license.
won't have effect + // so put an additional one + buffer.push(""); + } + const bufferValue = buffer.join("
"); + dataValue["value"] = bufferValue; + useLines.push(dataValue); + buffer = []; + } + } + for (let line of lines) { + if (line === progressLiteralStart) { + saveBuffer(); + useLines.push({ + type: "progress" + }); + } else if (line.startsWith(promptLiteralStart)) { + saveBuffer(); + const value = line.replace(promptLiteralStart, "").trimEnd(); + useLines.push({ + type: "input", + value: value + }); + } else if (line.startsWith("// ")) { + saveBuffer(); + const value = "💬 " + line.replace("// ", "").trimEnd(); + useLines.push({ + value: value, + class: "termynal-comment", + delay: 0 + }); + } else if (line.startsWith(customPromptLiteralStart)) { + saveBuffer(); + const promptStart = line.indexOf(promptLiteralStart); + if (promptStart === -1) { + console.error("Custom prompt found but no end delimiter", line) + } + const prompt = line.slice(0, promptStart).replace(customPromptLiteralStart, "") + let value = line.slice(promptStart + promptLiteralStart.length); + useLines.push({ + type: "input", + value: value, + prompt: prompt + }); + } else { + buffer.push(line); + } + } + saveBuffer(); + const div = document.createElement("div"); + node.replaceWith(div); + const termynal = new Termynal(div, { + lineData: useLines, + noInit: true, + lineDelay: 500 + }); + termynals.push(termynal); + }); +} + +function loadVisibleTermynals() { + termynals = termynals.filter(termynal => { + if (termynal.container.getBoundingClientRect().top - innerHeight <= 0) { + termynal.init(); + return false; + } + return true; + }); +} +window.addEventListener("scroll", loadVisibleTermynals); +createTermynals(); +loadVisibleTermynals(); \ No newline at end of file diff --git a/js/termynal.js b/js/termynal.js new file mode 100644 index 00000000..6c66d3fe --- /dev/null +++ b/js/termynal.js @@ -0,0 +1,197 @@ +/** + * termynal.js + * A lightweight, modern and extensible animated terminal window, using + * async/await. + * + * @author Ines Montani
Documentation: https://kwik.rocks
Repository: https://github.com/dmezzogori/kwik
Kwik is a web framework for building modern, batteries-included, RESTful backends with Python 3.10+. Kwik is based on FastAPI, builds upon it and delivers an opinionated concise, business-oriented API.
The key features are:
- Conciseness: Kwik is quick (pun-intended )
- Battle-tested: developed internally at Kheperer, we use it every day to build robust and modern solutions for our customers.
- Standards-based
Warning
While Kwik is in active development, and already used for production, it is still in a pre-release state.
The API is subject to change, and the documentation is not complete yet.
"},{"location":"#acknowledgments","title":"Acknowledgments","text":"Python 3.10+
Kwik stands on the shoulder of a couple of giants:
- FastAPI: for the web parts.
- SQLAlchemy: for the ORM part.
$ pip install kwik\n---> 100%\nInstalled\nIt will install kwik and all its dependencies.
"},{"location":"#example","title":"Example","text":""},{"location":"#run-it","title":"Run it","text":"$ python -m kwik\nUvicorn running on http://localhost:8080 (Press CTRL+C to quit)\nIf kwik is started in this way, it automatically creates a development server on port 8080, with hot-reloading enabled
Open your browser at http://localhost:8080/docs.
You will see the automatic interactive API documentation, showing the built-in endpoints and schemas.
"},{"location":"#license","title":"License","text":"This project is licensed under the terms of the MIT license.
"},{"location":"features/","title":"Features","text":"Kwik features
Kwik gives you the following features:
- FastAPI-based: all amazing FastAPI features are available, such as:
- Automatic interactive API documentation.
- Modern Python standards-based type hints.
- Automatic settings management from environment variables.
- Pydantic-based validation of settings.
- Database connections management via settings variables.
-
Dependency injection
- Automatic injection of database connections, with related transaction management.
- Automatic injection of user credentials in request-response cycle.
-
ORM support for Soft Delete pattern and automatic Audit.
- Authentication support with JWT (OAuth2.0 based).
- Permission and Roles management built-in.
Kwik is meant to be a batteries-included web framework for building modern, RESTful backends with Python 3.10+.
As such, it handles automatically many of the tedious aspects of building a web application, such as:
- Database connection and transaction management
- User authentication and authorization
- Settings management
- Modern and consolidated best-practices, such as auditing, soft-delete, etc.
The objective of Kwik is to provide a concise API, which is easy to learn and use, and which is also easy to extend. Kwik is operationally extensible with any existing FastAPI application.
The objective of Kwik is to uplift the developer experience, by providing a framework which is easy to use, and which is also easy to extend.
In the simplest of the cases, the developer just need to define the SQL models that represent the data, and the Kwik framework will automatically provide the RESTful APIs for CRUD operations.
Kwik also aims at enabling the developer to follow efficiently the best practices of the industry, such as Test-Driven Development. Kwik is designed to be easily testable, and it provides a set of fixtures that can be used to test the application.
Kwik is 100% tested.
"},{"location":"tutorial/auditing/","title":"Auditing","text":""},{"location":"tutorial/configuration/","title":"Configuration","text":"The configuration of a Kwik application is done through the use of environment variables.
The handling of the configuration is done by the Pydantic library, which is used by Kwik to validate the settings.
Warning
The configuration is done through environment variables, which are not secure. You should not use them to store sensitive information, like passwords, tokens, etc.
Instead, you should use the SecretStr type, which will read the values from environment variables, but will not show them in the documentation.
The following are the main configuration variables available, and corresponding default values:
- General:
SERVER_NAME:backend- The name of the server/service on which the application is running (i.e. docker service name).HOST:localhost- The hostname on which the application is running.PORT:8080- The port on which the application is running.API_V1_STR:/api/v1- The base path for the API.PROJECT_NAME:kwik- The name of the project being developed.
- Database:
POSTGRES_SERVER:db- The hostname of the database server.POSTGRES_DB:db- The name of the database.POSTGRES_USER:postgres- The username to use to connect to the database.POSTGRES_PASSWORD:root- The password to use to connect to the database.ENABLE_SOFT_DELETE:False- A flag to enable/disable soft delete.
- Mailserver:
SMTP_HOSTSMTP_PORTSMTP_USERSMTP_PASSWORDSMTP_TLS
- Superuser credentials:
FIRST_SUPERUSER:admin@example.com- The email address of the admin superuser.FIRST_SUPERUSER_PASSWORD:admin- The password of the admin superuser.
- Misc:
DEBUG:True- A flag to enable/disable debug mode.HOTRELOAD:True- A flag to enable/disable hot reloading.WEBSOCKET_ENABLED:False- A flag to enable/disable websocket support.
Note
The default values are used only for development purposes. In production, you should always override them with the appropriate values.
Moreover, you should be aware that environment variables names are case sensitive.
"},{"location":"tutorial/database/","title":"Database","text":""},{"location":"tutorial/endpoints/","title":"Endpoints","text":""},{"location":"tutorial/first-steps/","title":"First steps","text":"To run your first Kwik application, once you have installed it all you need to do is to create a file named app.py with the following content:
from kwik import Kwik, run\nfrom kwik.api.api import api_router\n\napp = Kwik(api_router)\n\nrun(app)\nThen run it with:
$ python app.py\n\nKwikApp ready\nKwikApp running on http://localhost:8080\nSwagger available at http://localhost:8080/docs\nThe run() function will start a development server on port 8080, with hot-reloading enabled.
Just point your browser to http://localhost:8080/docs, and you will see the automatic interactive API documentation.
"},{"location":"tutorial/first-steps/#what-just-happened","title":"What just happened?","text":"The Kwik class is the main entry point for your application.
It takes a list of routers, which are the components that define the endpoints of your application.
In this case, we are using the api_router from kwik.api.api, which is the default router for the built-in endpoints. The default endpoints, as they can be seen in the above picture, are:
/api/v1/login: to handle user authentication and token generation./api/v1/users: to handle user management./api/v1/roles: to handle role management./api/v1/permissions: to handle permission management.
Now that you have your first Kwik application running, you are probabily interested in the following:
- how is the configuration handled? Go to the configuration tutorial.
- you can go to the endpoints tutorial to learn how to add your own endpoints.
- you can go to the database tutorial to learn how to use the database.
Auditing¶
Configuration¶
The configuration of a Kwik application is done through the use of environment variables.
The handling of the configuration is done by the Pydantic library, which is used by Kwik to validate the settings.
Warning
The configuration is done through environment variables, which are not secure. You should not use them to store sensitive information, like passwords, tokens, etc.
Instead, you should use the SecretStr type, which will read the values from environment variables, but will not show them in the documentation.
The following are the main configuration variables available, and corresponding default values:
- General:
SERVER_NAME:backend- The name of the server/service on which the application is running (i.e. docker service name).HOST:localhost- The hostname on which the application is running.PORT:8080- The port on which the application is running.API_V1_STR:/api/v1- The base path for the API.PROJECT_NAME:kwik- The name of the project being developed.
- Database:
POSTGRES_SERVER:db- The hostname of the database server.POSTGRES_DB:db- The name of the database.POSTGRES_USER:postgres- The username to use to connect to the database.POSTGRES_PASSWORD:root- The password to use to connect to the database.ENABLE_SOFT_DELETE:False- A flag to enable/disable soft delete.
- Mailserver:
SMTP_HOSTSMTP_PORTSMTP_USERSMTP_PASSWORDSMTP_TLS
- Superuser credentials:
FIRST_SUPERUSER:admin@example.com- The email address of the admin superuser.FIRST_SUPERUSER_PASSWORD:admin- The password of the admin superuser.
- Misc:
DEBUG:True- A flag to enable/disable debug mode.HOTRELOAD:True- A flag to enable/disable hot reloading.WEBSOCKET_ENABLED:False- A flag to enable/disable websocket support.
Note
The default values are used only for development purposes. In production, you should always override them with the appropriate values.
Moreover, you should be aware that environment variables names are case sensitive.
Database¶
Endpoints¶
First steps¶
To run your first Kwik application, once you have installed it all you need to do is to create a file named app.py with the following content:
from kwik import Kwik, run
+from kwik.api.api import api_router
+
+app = Kwik(api_router)
+
+run(app)
+Then run it with:
$ python app.py
+
+KwikApp ready
+KwikApp running on http://localhost:8080
+Swagger available at http://localhost:8080/docs
+The run() function will start a development server on port 8080, with hot-reloading enabled.
Just point your browser to http://localhost:8080/docs, and you will see the automatic interactive API documentation.
What just happened?¶
The Kwik class is the main entry point for your application.
It takes a list of routers, which are the components that define the endpoints of your application.
In this case, we are using the api_router from kwik.api.api, which is the default router for the built-in endpoints. The default endpoints, as they can be seen in the above picture, are:
/api/v1/login: to handle user authentication and token generation./api/v1/users: to handle user management./api/v1/roles: to handle role management./api/v1/permissions: to handle permission management.
Next steps¶
Now that you have your first Kwik application running, you are probabily interested in the following:
- how is the configuration handled? Go to the configuration tutorial.
- you can go to the endpoints tutorial to learn how to add your own endpoints.
- you can go to the database tutorial to learn how to use the database.
Guards¶
Introduction¶
Kwik is meant to be a batteries-included web framework for building modern, RESTful backends with Python 3.10+.
As such, it handles automatically many of the tedious aspects of building a web application, such as:
- Database connection and transaction management
- User authentication and authorization
- Settings management
- Modern and consolidated best-practices, such as auditing, soft-delete, etc.
The objective of Kwik is to provide a concise API, which is easy to learn and use, and which is also easy to extend. Kwik is operationally extensible with any existing FastAPI application.
The objective of Kwik is to uplift the developer experience, by providing a framework which is easy to use, and which is also easy to extend.
In the simplest of the cases, the developer just need to define the SQL models that represent the data, and the Kwik framework will automatically provide the RESTful APIs for CRUD operations.
Kwik also aims at enabling the developer to follow efficiently the best practices of the industry, such as Test-Driven Development. Kwik is designed to be easily testable, and it provides a set of fixtures that can be used to test the application.
Kwik is 100% tested.