1
0
Fork 0
mirror of https://gitee.com/fantix/kloop.git synced 2024-05-03 13:48:47 +00:00

Update README and add Makefile

This commit is contained in:
Fantix King 2022-03-19 17:38:34 -04:00
parent 9cdc246ca9
commit 04b59cc52e
No known key found for this signature in database
GPG key ID: 95304B04071CCDB4
3 changed files with 33 additions and 3 deletions

View file

@ -1,3 +1,4 @@
include Makefile
recursive-include src *.pyx *.pxd
graft tests
global-exclude *.py[cod] *.c

15
Makefile Normal file
View file

@ -0,0 +1,15 @@
.PHONY: build dev clean
.DEFAULT_GOAL := dev
build:
pip install -U build
python -m build
dev:
pip install -Ue .
clean:
git clean -Xfd -e "!/*.code-workspace" -e "!/*.vscode" -e "!/*.idea" -e "!/*.python-version"

View file

@ -1,5 +1,19 @@
# kLoop
kLoop is an implementation of the Python asyncio event loop written in Cython,
using io_uring and kTLS features of the Linux kernel, open-sourced and released
under the MulanPSL - 2.0 license.
kLoop is an implementation of the Python
[asyncio](https://docs.python.org/3/library/asyncio.html) event loop written
in [Cython](https://cython.org/), using
[io_uring](https://unixism.net/loti/what_is_io_uring.html) and
[kTLS](https://www.kernel.org/doc/html/latest/networking/tls-offload.html)
features of the Linux kernel, open-sourced and released
under the [MulanPSL - 2.0 license](http://license.coscl.org.cn/MulanPSL2).
**⚠WARNING: THIS PROJECT IS IN PROOF-OF-CONCEPT STAGE!⚠️**
## Requirements
* Python >= 3.8
* Linux >= 5.11 (enable ktls with `modprobe ktls`)
* OpenSSL 1.1.1 (3.0 is unnecessary)