Archived

This repository has been archived on 2022-03-12. You can view files and clone it, but cannot push or open issues or pull requests.

History

Alexander Polynomdivision 842e685c59 scripts: Add level descriptions and names		2018-10-22 18:39:24 +02:00
..
add_level.py	scripts: Add add_level.py	2018-10-01 17:33:25 +02:00
add_user.js	scripts: Add scripts to help testing and administration	2018-10-01 17:08:37 +02:00
csv_level_to_db.py	scripts: Add level descriptions and names	2018-10-22 18:39:24 +02:00
csv_vocab_to_mongo.py	scripts: Include mnemonics	2018-10-21 22:44:20 +02:00
generate_test_levels.py	scripts: Add and fix the debug flag	2018-10-11 17:25:19 +02:00
package-lock.json	scripts: Add scripts to help testing and administration	2018-10-01 17:08:37 +02:00
README.md	docs: Fix formatting issues	2018-10-09 16:25:32 +02:00

README.md

Scripts

A few scripts to help with any task

csv_vocab_to_mongo.py

Parses the vocabulary files in $REPO_ROOT/data/vocab/, converts the vocabulary items into a format that fits the database model for vocabulary items (see backend/db.md) and writes the data into the MongoDB database.

NOTE: Requires pymongo to be installed via pip

Usage

python csv_vocab_to_mongo.py <URI> <Database>

URI: The URI of the MongoDB instance
Database: The name of the database in the MongoDB instance

add_user.js

Asks the user about his data (username, password, class** and adds the user to the database.

NOTE: Requires mongodb to be installed via npm

NOTE: This script is written in JavaScript, so we can ensure that the same pbkdf2 function is used to create the user and to hash the password later on.

Usage

node add_user.js <URI> <Database>

URI: The URI of the MongoDB instance
Database: The name of the database in the MongoDB instance

add_level.py

Asks about a new level to add

NOTE: Requires mongodb to be installed via npm

Usage

URI: The URI of the MongoDB instance
Database: The name of the database in the MongoDB instance

generate_test_levels.py

Generates 10 levels with names and a description. The name and the description are generated using Markov Chains, while the Bee Movie script serves as data for the model.

Note: Requires mongodb, markovify to be installed via pip Note: Requires the file bee-movie.txt to be in the same folder as the script

Usage

URI: The URI of the MongoDB instance
Database: The name of the database in the MongoDB instance