sqlab

SQL Adventure Builder: transform a dataset and a collection of SQL exercises into a self-contained database

https://github.com/laowantong/sqlab

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary

Keywords

database education game-engine games sql text-adventure
Last synced: 6 months ago · JSON representation ·

Repository

SQL Adventure Builder: transform a dataset and a collection of SQL exercises into a self-contained database

Basic Info
  • Host: GitHub
  • Owner: laowantong
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 1.24 MB
Statistics
  • Stars: 10
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Topics
database education game-engine games sql text-adventure
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

SQLab

SQL adventure builder logo

An SQLab adventure is a text-based game where the player evolves through a series of isolated or interconnected puzzles by crafting SQL queries.

It consists in a standalone database encompassing the core dataset, a handful of stored procedures, and a table of encrypted messages (such as narrative elements, puzzle statements, answers, explanations, etc.).

There is no requirement to wrap a dedicated application around this database to “run” the game. It can be played on any generic GUI such as DBeaver, phpMyAdmin, pgAdmin, or directly in a command-line interface.

Each question comes with a unique formula, for example, salt_042(sum(hash) OVER ()). Appended to the SELECT clause, this formula calculates a decryption token, which may unlock the next episode or, if the query is incorrect, a tailored hint (assuming the game's creator has provided one).

In an educational context, this setup enables the students to learn and practice SQL without constant oversight. The instructor might stave off boredom by logging their queries and injecting new hints as needed, improving the game for all involved.

Examples on GitHub

| Game | Pitch | Versions | DBMS | Included | | --- | --- | --- | --- | --- | | SQLab Island | An adaptation of SQL Island by Johannes Schildgen | English | MariaDB, MySQL, PostgreSQL, SQLite | Sources + SQLab database | | SQLab Sessform | A set of independent exercises + Mortelles Sessions, a police investigation on a training company | French | MySQL, PostgresQL | SQLab database | | SQLab Corbeau | An original adaptation of the movie Le Corbeau by Henri-Georges Clouzot (1943) | French | MySQL | Sources + SQLab database | | SQLab Club | An adaptation of PostgreSQL Exercises by Alisdair Owens | English | PostgreSQL | Sources + SQLab database (coming later) |

How can I create my own SQLab adventure?

The sqlab command-line tool is not required to play, but is necessary to create a new adventure.

pip install sqlab

The documentation is not yet available. In the meantime, you may explore the repository of SQLab Island. The provided dataset and Jupyter notebooks serve as source material for the generation of the SQLab database.

Owner

  • Name: Aristide
  • Login: laowantong
  • Kind: user
  • Location: Metz, France
  • Company: Université de Lorraine

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: SQLab
message: 'If you use this software, please cite it as below.'
type: software
authors:
  - given-names: Aristide
    family-names: Grange
    email: aristide.grange@univ-lorraine.fr
    affiliation: 'LCOMS EA7306, Université de Lorraine, Metz, France'
    orcid: 'https://orcid.org/0000-0001-5777-4603'
repository-code: 'https://github.com/laowantong/sqlab'
repository-artifact: 'https://pypi.org/project/sqlab/'
abstract: >-
  SQL Adventure Builder: Transform a dataset and a
  collection of SQL exercises into a self-contained
  database, and embark your students on a journey through
  encrypted puzzles, with automatic validation of correct
  answers and hints provided for incorrect attempts.
keywords:
  - education
  - games
  - sql
  - database
  - game-engine
  - text-adventure
license: MIT
date-released: '2024-03-03'

GitHub Events

Total
  • Create event: 3
  • Issues event: 2
  • Release event: 2
  • Watch event: 9
  • Issue comment event: 1
  • Push event: 30
  • Pull request review event: 2
  • Pull request event: 4
  • Fork event: 6
Last Year
  • Create event: 3
  • Issues event: 2
  • Release event: 2
  • Watch event: 9
  • Issue comment event: 1
  • Push event: 30
  • Pull request review event: 2
  • Pull request event: 4
  • Fork event: 6

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 2
  • Average time to close issues: 1 minute
  • Average time to close pull requests: 6 minutes
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: 1 minute
  • Average time to close pull requests: 6 minutes
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Dracaukwak (1)
Pull Request Authors
  • Dracaukwak (2)
  • laowantong (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 49 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 11
  • Total maintainers: 1
pypi.org: sqlab

SQL Adventure Builder: a command line tool for creating standalone SQL activities.

  • Versions: 11
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 49 Last month
Rankings
Dependent packages count: 9.8%
Average: 37.1%
Dependent repos count: 64.4%
Maintainers (1)
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
  • cmd2 ^2.4.3
  • jupysql ^0.10.10
  • mysql-connector-python ^8.2.0
  • psycopg2 ^2.9.9
  • python ^3.8.0
  • sqlalchemy 2.0.27
  • sqlparse ^0.4.4