Metadata-Version: 2.1
Name: kwik
Version: 0.1.0
Summary: 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.
Home-page: https://kwik.rocks
Author: Davide Mezzogori
Author-email: dmezzogori@users.noreply.github.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aiofiles (>=22.1.0,<23.0.0)
Requires-Dist: alembic (>=1.8.1,<2.0.0)
Requires-Dist: asyncpg (>=0.27.0,<0.28.0)
Requires-Dist: bcrypt (>=4.0.1,<5.0.0)
Requires-Dist: broadcaster (>=0.2.0,<0.3.0)
Requires-Dist: fastapi (>=0.87.0,<0.88.0)
Requires-Dist: httptools (>=0.5.0,<0.6.0)
Requires-Dist: passlib (>=1.7.4,<2.0.0)
Requires-Dist: psycopg2-binary (>=2.9.5,<3.0.0)
Requires-Dist: pydantic[email] (>=1.10.2,<2.0.0)
Requires-Dist: python-jose (>=3.3.0,<4.0.0)
Requires-Dist: python-multipart (>=0.0.5,<0.0.6)
Requires-Dist: sqlalchemy (>=1.4.44,<2.0.0)
Requires-Dist: uvicorn (>=0.20.0,<0.21.0)
Requires-Dist: websockets (>=10.4,<11.0)
Description-Content-Type: text/markdown

# Kwik

![Logo](docs/handbook/docs/img/logo.png)

---

**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 :smile:)
* **Battle-tested**: developed internally at [Kheperer](https://kheperer.it), 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](https://fastapi.tiangolo.com/): for the web parts.
* [SQLAlchemy](https://www.sqlalchemy.org/): for the ORM part.

## Installation

```console
$ pip install kwik
```

It will install kwik and all its dependencies.

## Example

### Run it

```console
$ python -m kwik
```


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.

![OpenAPI](docs/handbook/docs/img/openapi.jpeg)


## License

This project is licensed under the terms of the MIT license.

