jetforce/README.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

2019-08-05 05:07:38 +02:00
<h1 align="center">Jetforce</h1>
2019-08-09 03:45:26 +02:00
2019-08-10 01:15:11 +02:00
<p align="center">An experimental python server for the new, under development Gemini Protocol.</p>
2019-08-09 03:45:26 +02:00
2019-08-24 05:21:43 +02:00
<p align="center">Learn more about Project Gemini <a href="https://gopher.commons.host/gopher://zaibatsu.circumlunar.space/1/~solderpunk/gemini">here</a>.</p>
2019-08-09 03:45:26 +02:00
2019-08-05 05:08:22 +02:00
<p align="center"><img alt="rocket launch" src="resources/rocket.jpg"/></p>
2019-08-05 04:57:34 +02:00
2019-08-09 03:45:26 +02:00
<p align="center">
<a href="https://pypi.python.org/pypi/jetforce/">
<img alt="pypi" src="https://img.shields.io/pypi/v/jetforce.svg?label=version"/>
</a>
<a href="https://github.com/michael-lazar/jetforce/LICENSE">
2019-08-23 02:41:43 +02:00
<img alt="License" src="https://img.shields.io/badge/license-FFSL%20v1-informational.svg">
2019-08-09 03:45:26 +02:00
</a>
<a href="https://github.com/psf/black">
<img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
</a>
<a href="https://saythanks.io/to/michael-lazar">
<img alt="say-thanks" src="https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg"/>
</a>
</p>
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
```