jetforce/README.md

32 lines
1.0 KiB
Markdown
Raw Normal View History

2019-08-24 05:36:24 +02:00
# Jetforce
An experimental python server for the new, under development Gemini Protocol.
Learn more about Project Gemini [here](https://gopher.commons.host/gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini).
![Rocket Launch](resources/rocket.jpg)
2019-08-09 03:45:26 +02:00
2019-08-05 04:57:34 +02:00
## Features
2019-08-24 05:21:43 +02:00
- A modern python codebase with type hinting and black formatting.
- A built-in static file server with support for gemini directory files.
- Lightweight, single-file framework with zero dependencies.
2019-08-05 04:57:34 +02:00
- 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
2019-08-24 05:29:18 +02:00
Requires Python 3.7+ and OpenSSL. The latest release of Jetforce can be downloaded from [PyPI](https://pypi.org/project/Jetforce/):
2019-08-05 04:57:34 +02:00
```bash
$ pip install jetforce
```
2019-08-24 05:29:18 +02:00
Or, you can download the repository and run the script directly:
2019-08-05 04:57:34 +02:00
```bash
$ git clone https://github.com/michael-lazar/jetforce
$ cd jetforce
2019-08-24 05:29:18 +02:00
$ ./jetforce.py
2019-08-05 04:57:34 +02:00
```