api.py is the Python script that defines the endpoint(s). Logic can be in api.py, or it can be imported from other Python modules if more complexity is required.
To start the REST server in dev mode, run:
hug -f api.py
This will start a server on port 8000. Navigate your browser to http://localhost:8000 and documentation of the endpoints appears.
To try out the POST endpoint, you can use curl or the Python requests library.
Ensure test libraries are installed with pip install -r tests_require.txt
Then, ensure the tests pass by running:
pytest
So far, we've only used the dev/test server built in to hug.
To deploy on a production-grade wsgi webserver,
we will use gunicorn. gunicorn is avaliable to install via pip and
is listed in requirements.txt.
To run on the command-line:
gunicorn -k gevent -b 0.0.0.0 api:__hug_wsgi__
This module also contains a Dockerfile that can be used to build an image that automates running the REST server. It installs all the required libraries and starts gunicorn, on port 8000. You need to expose port 8000 to access it from the host machine.