From 84053dc26bd018a04a9d917e2eb057d1c09920df Mon Sep 17 00:00:00 2001 From: Erik Wickstrom Date: Fri, 22 Apr 2016 12:44:15 -0700 Subject: [PATCH] Move REST API to it's own directory. --- examples/rest/README.md | 7 +++++++ examples/{ => rest}/rest.py | 0 2 files changed, 7 insertions(+) create mode 100644 examples/rest/README.md rename examples/{ => rest}/rest.py (100%) diff --git a/examples/rest/README.md b/examples/rest/README.md new file mode 100644 index 0000000..cc79526 --- /dev/null +++ b/examples/rest/README.md @@ -0,0 +1,7 @@ +The REST API example will run on port 5000 of host 0.0.0.0 (all interfaces) and be secured by SSL (self-signed certificate). + + python example/rest/rest.py + +To secure your API with a username and password (*highly recommended if exposing to the live internet*), set the PYCIRCULATE_USERNAME and PYCIRCULATE_PASSWORD environment variables. + + PYCIRCULATE_USERNAME="myusername" PYCIRCULATE_PASSWORD="password" python examples/rest/rest.py diff --git a/examples/rest.py b/examples/rest/rest.py similarity index 100% rename from examples/rest.py rename to examples/rest/rest.py