search

Princeton-CDH / bluemountainsprings

A RESTful API to Blue Mountain
0 stars 2 forks source link

expand tutorial material #57

Closed cwulfman closed 7 years ago

cwulfman commented 7 years ago

The API documentation should be expanded to include more examples of searches and queries that users might want to perform; in effect, these are additions to the tutorial material. BMS has only a small user population at this point, so it is difficult to speculate about what kinds of searches might be representative. Your additions should cover a reasonable spectrum of possibilities, but need not be exhaustive.

The examples should include a complete instance of how to connect the results of a BMS query to Voyant, and an instance showing how to connect to Palladio, as representatives of widely used DH systems.

The examples should also include at least one instance of using the API to query BMS from a standard programming language like Ruby or Python, parsing the resulting JSON or XML and performing some analysis or reformatting on it.

All examples must have been tested and must work as shown.

cwulfman commented 7 years ago

I wrote a simple ruby script, demo/demo1.rb, that shows how to get a set of issues filtered by publication date and primary language.

cwulfman commented 7 years ago

Wrote two short tutorials elaborating on how to use Springs with Voyant and Palladio. Made the demo script a tutorial as well.