lispy-education
/
ritherdon-rest
Archived
1
0
Fork 0
Code Releases Activity
Browse Source

update README.

unstable
Craig Oates 3 years ago
parent
0731e3f730
commit
5d7d4c5e20
1 changed files with 14 additions and 10 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 24
      README.md

24
README.md
Unescape View File

@ -1,7 +1,7 @@
# Ritherdon REST # Ritherdon REST
A package which grabs data from the [Return to A package which grabs data from the [Return to
Ritherdon[(http://ritherdon.abbether.net/) project's REST API server. Ritherdon](http://ritherdon.abbether.net/) project's REST API server.
The intended way to use this code is within a Lisp REPL -- something The intended way to use this code is within a Lisp REPL -- something
like SLIME in Emacs or Steel Bank Common Lisp (SBCL). If they do not like SLIME in Emacs or Steel Bank Common Lisp (SBCL). If they do not
@ -121,8 +121,8 @@ To load the system via ASDF, enter the following into SBCL or SLIME,
(ritherdon-rest:parse-request "/status/latest/1") (ritherdon-rest:parse-request "/status/latest/1")
;;; The 'ritherdon-rest.asd' file has connected the test system to the ;;; The 'ritherdon-rest.asd' file has connected the test system to the
main system. So you can run the tests from the main system. In other ;;; main system. So you can run the tests from the main system. In other
words, to run the tests, ;;; words, to run the tests,
(asdf:test-system :ritherdon-rest) ;Instead of ':ritherdon-rest/tests'. (asdf:test-system :ritherdon-rest) ;Instead of ':ritherdon-rest/tests'.
``` ```
If you are making repeated calls and want to reduce the amount of If you are making repeated calls and want to reduce the amount of
@ -133,7 +133,7 @@ and call its functions directly.
;;; This removes the need to type the 'ritherdon-rest:' part all the time. ;;; This removes the need to type the 'ritherdon-rest:' part all the time.
(in-package :ritherdon-rest) (in-package :ritherdon-rest)
(parse-request "/status/latest") (parse-request "/status/latest")
(parse-request "/reading/latest/2) (parse-request "/reading/latest/2")
(parse-request "reading/all/1") (parse-request "reading/all/1")
;;; To return to the default package, ;;; To return to the default package,
@ -145,15 +145,19 @@ and call its functions directly.
This repository is to help me learn Common Lisp. Because of this, This repository is to help me learn Common Lisp. Because of this,
there is no Issue Tracker, Wiki or Requests section. I have made this there is no Issue Tracker, Wiki or Requests section. I have made this
repository public on the off-chance is might help you learning about repository public on the off-chance is might help you learning about
Common Lisp. Common Lisp by seeing something in-situ.
The Return to Ritherdon API has HTTP-Push requests. I have not The [Return to Ritherdon API](http://ritherdon.abbether.net/api/ui/)
provided any functions to make these types of requests because I do has HTTP-Push requests. I have not provided any functions to make
not want to run the risk of breaking that system. The API is part of these types of requests because I do not want to run the risk of
an active art exhibition and I do not want to corrupt the data it breaking that system. The API is part of an active art exhibition and
stores/created in any way. I do not want to corrupt the data it stores/created in any way.
I have ran this project on Linux and nothing else. I have no idea if I have ran this project on Linux and nothing else. I have no idea if
this work on Windows or MacOS. I, also, have no urge to find this work on Windows or MacOS. I, also, have no urge to find
out. Unfortunately, you are on your own here because I have no means out. Unfortunately, you are on your own here because I have no means
to test it. to test it.
As stated near the top of this document, I am expecting to shutdown
the API near the end of 2021. When that happens, this will remain as a
reference repository.