zooniverse/classroom-maps-api

Mapping API for the https://classroom.zooniverse.org service. Built using https://datasette.io/ to provide a JSON API over SQLite databases with custom project CSV data.

Installation

Use docker and docker-compose, no other way is supported

Getting Started

Convert source data files to a working zip format

Only use do this if you are adding new data files to this system.

Use the following cmd format the zip files correctly

zip -r $project_name.zip $project_csv_file_dir/

If you need to modify a source CSV file, e.g. to fix non https URLs, see rewrite-gorongosa-http-urls.sh for an example.

Building the SQLite db(s)

Use custom docker image to build the dbs

The following will build a sqlite db for each directory containing csv files in the /data/ directory of this repository

docker-compose build

Run Datasette with the built sql databases from above

docker-compose up

This will start datasette and serve all the newly created files at http://127.0.0.1:8001

See docker-compose.yaml for more information

Run SQL queires directly against the databases

GeoJSON format

• http://127.0.0.1:8001/darien.geojson?sql=select+*from+cameras+limit+10

JSON format

• http://127.0.0.1:8001/darien.json?sql=select+*from+subjects+where+subject_id=15684586

HTML format

• http://127.0.0.1:8001/darien?sql=select+*from+subjects+where+subject_id=15684586

Manually interact with the sqlite db or datasette via bash

docker-compose run --rm --service-ports datasette bash
# do what you want on the file system
#
# re-run the builder script manually
labs-import-csv-files-to-sqlite.sh
#
# use sqlite repl to interact with the database.db file
sqlite3 /mnt/databases/folder/database.db
#
# start datasette in config directoy & cors mode
datasette -h 0.0.0.0 --cors ./databases