diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8dbf34 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Why? + +Sometimes I run long scripts on a remote machine and I want to know when they finish. It's +not urgent enough that I need a text or toot, but being able to pull up a simple page that +shows what is done and not done makes it easy to check periodically. + +# How? + +This tiny Flask API runs on a server (Raspberry Pi, etc.). It has very basic authentication +and waits for a curl (or similar) GET request with some small amount of data. The data are +displayed on a simple web page. + +The reason for a simple GET request is to make this as code-agnostic as possible. Drop a +curl command into R or Python or Go or Ruby or whatever (I assume) and be able to watch +whatever data you pass. + +You can either run with the internal Flask development server or something like gunicorn. + +# Other Use Cases? + +I'm sure there are some. + +# Security? + +I'm sure this isn't very secure. It has basic data cleaning, string length limits, and +username/password protection. There is no database--all data are kept in memory and will +disappear when the server is stopped. Use at your own risk, don't reuse passwords, and +obviously don't pass data that can't be shared openly online. The last part includes things +like "front_door_unlocked"--use common sense. \ No newline at end of file diff --git a/app.py b/app.py index 11bb3ba..a3edb7a 100644 --- a/app.py +++ b/app.py @@ -10,7 +10,8 @@ app = Flask(__name__) statuses = [ { - 'title': 'curl -u matt:python -i http://localhost:5000/log/api/v1.0/new?title="example_status_no_spaces"', + 'title': 'app_is_running', + 'color': "green", 'timestamp': datetime.datetime.now().timestamp(), 'timestamp_readable': datetime.datetime.now() } @@ -38,6 +39,7 @@ def create_status(): status = { 'title': safer_title, + 'color': request.args.get("color"), 'timestamp': datetime.datetime.now().timestamp(), 'timestamp_readable': datetime.datetime.now() } @@ -57,7 +59,7 @@ def get_statuses_raw(): @app.route('/', methods=['GET']) def get_statuses(): long_agos = [humanfriendly.format_timespan(datetime.datetime.now().timestamp() - status['timestamp']) for status in statuses[::-1]] - return render_template("list.html", + return render_template("index.html", statuses = statuses[::-1], long_agos = long_agos) diff --git a/static/css/style.css b/static/css/style.css index dd5f784..b604a78 100644 --- a/static/css/style.css +++ b/static/css/style.css @@ -1,3 +1,4 @@ .statuses tr td { border: 1px solid black; + padding: 5px; } \ No newline at end of file diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..5d05364 --- /dev/null +++ b/templates/index.html @@ -0,0 +1,39 @@ + + + + + + +
seconds until refresh
+ + + + + {% for status in statuses %} + + + + {% endfor %} +
What Happened?When Did It Happen?How Long Has It Been?
{{ status.title }}{{ status.timestamp_readable }}{{ long_agos[loop.index0] }}
+ +

How does this work?

+ +

Send a curl (or similar) request from any script or code and include your username and +password (see app.py, @auth.get_password).

+ + +curl -u username:password -i "http://localhost:5000/new?title=a_status_without_spaces_goes_here" + + +

The entire list of statuses is kept in memory and limited to 1000 (or whatever you set +it to). If your service or server restarts, the list is wiped out.

+ + + diff --git a/templates/list.html b/templates/list.html deleted file mode 100644 index 148579b..0000000 --- a/templates/list.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - {% for status in statuses %} - - - - {% endfor %} -
What Happened?When Did It Happen?How Long Has It Been?
{{ status.title }}{{ status.timestamp_readable }}{{ long_agos[loop.index0] }}
- - - - -