jetforce/README.md

32 lines
1.0 KiB
Markdown
Raw Normal View History

2019-08-05 05:07:38 +02:00
<h1 align="center">Jetforce</h1>
<p align="center">A python server framework for the new, under development Gemini Protocol.</p>
<p align="center"><img alt="rocket launch" src="resources/rocket.jpg"/></p>
<p align="center">Learn more about Project Gemini from its author, ~solderpunk,
<a href="https://gopher.commons.host/gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini">here</a>.</p>
2019-08-05 04:57:34 +02:00
## Features
- A modern Python 3 codebase with type hinting and black formatting.
- Lightweight, single-file web framework with zero dependencies.
- A built-in static file server with support for *.gemini* directory map files.
- Supports concurrent connections using an asynchronous event loop.
- Extendable - loosely implements the [WSGI](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) server/application pattern.
## Installation
Requires Python 3.6+ and OpenSSL
### pip
```bash
$ pip install jetforce
```
### git
```bash
$ git clone https://github.com/michael-lazar/jetforce
$ cd jetforce
$ python jetforce.py
```