rsmanage package¶
rsmanage¶
Type subcommand –help for help on any subcommand
rsmanage [OPTIONS] COMMAND [ARGS]...
Options
- --verbose¶
More verbose output
- --if_clean¶
only run if database is uninitialized
addattribute¶
Add an attribute to the course_attributes table
rsmanage addattribute [OPTIONS]
Options
- --course <course>¶
Name of the course
- --attr <attr>¶
Attribute to add
- --value <value>¶
Attribute Value
addcourse¶
Create a course in the database
rsmanage addcourse [OPTIONS]
Options
- --course-name <course_name>¶
The name of a course to create
- --basecourse <basecourse>¶
The name of the basecourse
- --start-date <start_date>¶
Start Date for the course in YYYY-MM-DD
- --python3, --no-python3¶
Use python3 style syntax
- --login-required, --no-login-required¶
Only registered users can access this course?
- --institution <institution>¶
Your institution
- --courselevel <courselevel>¶
Your course level
- --allowdownloads <allowdownloads>¶
enable download button
- --language <language>¶
Default Language for your course
- --host <host>¶
runestone server host name
- --newserver, --no-newserver¶
use the new book server
- --allow_pairs, --no-allow-pairs¶
enable experimental pair programming support
addeditor¶
Add an existing user as an editor for a given base course
rsmanage addeditor [OPTIONS]
Options
- --username <username>¶
user to promote to instructor
- --basecourse <basecourse>¶
name of base course
addinstructor¶
Add an existing user as an instructor for a course
rsmanage addinstructor [OPTIONS]
Options
- --username <username>¶
user to promote to instructor
- --course <course>¶
name of course
adduser¶
Add a user (or users from a csv file)
rsmanage adduser [OPTIONS]
Options
- --instructor¶
Make this user an instructor
- --fromfile <fromfile>¶
read a csv file of users of the form username, email, first_name, last_name, password, course
- --username <username>¶
Username, must be unique
- --password <password>¶
password - plaintext – sorry
- --first_name <first_name>¶
Real first name
- --last_name <last_name>¶
Real last name
- --email <email>¶
email address for password resets
- --course <course>¶
course to register for
- --ignore_dupes¶
ignore duplicate student errors and keep processing
build¶
rsmanage build [options] COURSE Build the book for an existing course
rsmanage build [OPTIONS] COURSE
Options
- --clone <clone>¶
clone the given repo before building
- --ptx¶
Build a PreTeXt book
- --gen¶
Build PreTeXt generated assets (a one time thing)
- --manifest <manifest>¶
Manifest file
Arguments
- COURSE¶
Required argument
courseinfo¶
List all information for a single course
rsmanage courseinfo [OPTIONS]
Options
- --name <name>¶
Name of the course
db¶
Connect to the database based on the current configuration
rsmanage db [OPTIONS]
env¶
Print out your configured environment If –checkdb is used then env will exit with one of the following exit codes
0: no database, no database folder 1: no database but databases folder 2: database exists but no databases folder 3: both database and databases folder exist
rsmanage env [OPTIONS]
Options
- --checkdb¶
check state of db and databases folder
grade¶
Grade a problem set; hack for long-running grading processes
rsmanage grade [OPTIONS]
Options
- --enforce¶
Enforce deadline when grading
- --course <course>¶
The name of a course that should already exist in the DB
- --pset <pset>¶
Database ID of the Problem Set
initdb¶
Initialize and optionally reset the database
rsmanage initdb [OPTIONS]
Options
- --list_tables¶
List all of the defined tables when done
- --reset¶
drop database and delete all migration information
- --force¶
answer Yes to confirm questions
instructors¶
List instructor information for all courses or just for a single course
rsmanage instructors [OPTIONS]
Options
- --course <course>¶
The name of a course that should already exist in the DB
library¶
subcommands for managing the library table
rsmanage library [OPTIONS] COMMAND [ARGS]...
forclass¶
Show or hide the book in the course creation page
rsmanage library forclass [OPTIONS] BOOK
Options
- --show, --hide¶
show the book in the custom course page
Arguments
- BOOK¶
Required argument
show¶
Show all data for this book in the library
rsmanage library show [OPTIONS] BOOK
Arguments
- BOOK¶
Required argument
visible¶
Show or hide the book on the library page
rsmanage library visible [OPTIONS] BOOK
Options
- --show, --hide¶
show the book in the library
Arguments
- BOOK¶
Required argument
peergroups¶
rsmanage peergroups [OPTIONS]
Options
- --course <course>¶
name of course
resetpw¶
Utility to change a users password. Useful If they can’t do it through the normal mechanism
rsmanage resetpw [OPTIONS]
Options
- --username <username>¶
Username, must be unique
- --password <password>¶
password - plaintext – sorry
rmuser¶
Utility to remove a user from the system completely.
rsmanage rmuser [OPTIONS]
Options
- --username <username>¶
Username, must be unique
studentinfo¶
display PII and all courses enrolled for a username
rsmanage studentinfo [OPTIONS]
Options
- --student <student>¶
Name of the student
Submodules¶
rsmanage.core module¶
- class rsmanage.core.Config¶
Bases:
object
- rsmanage.core.checkEnvironment()¶
Check the list of required and optional environment variables to be sure they are defined.
- rsmanage.core.check_db_connection(config)¶
- rsmanage.core.check_db_for_useinfo(config)¶
- rsmanage.core.echoEnviron(config)¶
- rsmanage.core.findProjectRoot()¶