Skip to content

hivesolutions/netius

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5873ca1 · Dec 14, 2023
Oct 15, 2023
Oct 11, 2013
Nov 21, 2020
May 17, 2023
Jan 2, 2020
Jun 27, 2016
Dec 28, 2016
Dec 14, 2023
Nov 1, 2021
Oct 11, 2013
Dec 13, 2018
Apr 26, 2022
Oct 15, 2023
Oct 21, 2014
Feb 2, 2015
Nov 21, 2023
Aug 1, 2016
Oct 31, 2014
Aug 4, 2015
Oct 15, 2023

Repository files navigation

Netius

Fast and readable async non-blocking network apps

Netius is a Python network library that can be used for the rapid creation of asynchronous non-blocking servers and clients. It has no dependencies, it's cross-platform, and brings some sample netius-powered servers out of the box, namely a production-ready WSGI server.

Simplicity and performance are the main drivers of this project. The codebase adheres to rigorous code standards and is extensively commented on. As far as performance is concerned, it aims to be up to par with equivalent native implementations, where PyPy can provide the extra boost to raise performance up to these standards.

Bear in mind that although netius is non-blocking, it will naturally still block if the operations performed within the event loop are blocking, like reading or writing a file, which are both blocking operations in the Python standard library. Running multiple netius instances in parallel, and having a fast server like NGINX acts as their reverse proxy, which is one way of minimizing the perceptibility of such blockages.

Installation

pip install netius

Or download the source from GitHub.

Netius has no dependencies and is therefore cross-platform. It's compatible with PyPy, with which its benefits of performance increase up to 1.5x - 2.5x faster in most environments, when compared with running it with the CPython interpreter.

Usage

WSGI Server

import netius.servers

def app(environ, start_response):
    status = "200 OK"
    contents = "Hello World"
    content_l = len(contents)
    headers = (
        ("Content-Length", content_l),
        ("Content-Type", "text/plain"),
        ("Connection", "keep-alive")
    )
    start_response(status, headers)
    yield contents

server = netius.servers.WSGIServer(app = app)
server.serve(port = 8080)

HTTP Client

Synchronous usage

import netius.clients
result = netius.clients.HTTPClient.get_s(
    "http://www.flickr.com/",
    asynchronous = False
)
print(result["data"])

Asynchronous usage

import netius.clients

def on_partial(client, parser, data):
    print(data)

def on_message(client, parser, message):
    netius.clients.HTTPClient.cleanup_s()

netius.clients.HTTPClient.get_s(
    "http://www.flickr.com/",
    callback = on_message,
    on_data = on_partial
)

Test servers

The servers that come with netius out-of-the-box, can be tested through the command line:

Class Example
WSGIServer python -m netius.servers.wsgi
FTPServer python -m netius.servers.ftp
HelloServer MESSAGE="Hello Netius" python -m netius.extra.hello
FileServer BASE_PATH=/ python -m netius.extra.file
SMTPServer python -m netius.servers.smtp
RelaySMTPServer python -m netius.extra.smtp_r

Learn more

Basic

Advanced topics

More information can be found in the Advanced Topics page.

License

Netius is currently licensed under the Apache License, Version 2.0.

Build Automation

Build Status Build Status GitHub Coverage Status PyPi Status License