Metadata-Version: 2.1
Name: ZeroSeg-API
Version: 0.1.4
Summary: REST API for ZeroSeg Improved library.
Home-page: https://github.com/samedamci/ZeroSeg_API
Author: samedamci
Author-email: samedamci@disroot.org
License: ISC
Project-URL: Issue tracker, https://github.com/samedamci/ZeroSeg_API/issues
Keywords: raspberry pi rpi led max7219 matrix seven segment zeroseg api
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: flask
Requires-Dist: ZeroSeg-Improved

# ZeroSeg API

REST API for [ZeroSeg Improved](https://github.com/samedamci/ZeroSeg) library. This API can be hosted on your Raspberry Pi device
for remote displaying information on LCD display purpose.

## Running

You probably don't need run it with extra options like HTTPS when you use it in your home
network. Of course if you want to deploy this API to be accesible outside your home you
always should enable TLS for example with NGINX reverse proxy + uWSGI or Gunicorn.

In this example you can see simplest way to run production server.

+ Install packages from PyPI.
```
$ pip3 install --user ZeroSeg_API gunicorn
```
+ Start server with Gunicorn CLI.
```
$ gunicorn ZeroSeg_API:app --log-file - --bind <LOCAL_IP>
```


