marksman 0.4.0

CLI Tool to manage marks of students efficiently.

marksman

CLI Tool to manage marks of students efficiently.

Features

• CRUD ( create / read / update / delete )
• Email ( email results to students )
• Visualize ( visualize the data )
• Utils ( fill dummy data / import from csv / export csv )

Getting Started

You must have Python 3.9 installed on your system.

Install easily via pip, Python's official Package Manager.

pip install marksman

Note: Linux and Mac users might have to use pip3 to invoke pip

Read this if you are new to command-line-interfaces.

Usage

Open your terminal and run marksman --help and you will get the following output.

usage: marksman [-h] [-l] [-v] {crud,email,visualize,utils} ...

CLI Tool to manage marks of students efficiently

optional arguments:
  -h, --help            show this help message and exit
  -l, --loud            increase output verbosity
  -v, --version         show programs version number and exit

actions:
  {crud,email,visualize,utils}
                        actions you can take
    crud                Do crud operations
    email               Email results to students
    visualize           Visualize the results
    utils               Additional utility tools for marksman

For tutorials and documentation visit https://git.io/JL1iI 

Tip: You can use the alias mm instead of typing the long marksman. Its already set for you when you install.

CRUD

Description of the crud

Usage

Running marksman crud --help will give this.

usage: marksman crud [-h] {students,exams,marks}

positional arguments:
  {students,exams,marks}
                        Choose what data you want to crud

optional arguments:
  -h, --help            show this help message and exit

Examples

Email

Usage

Running marksman email --help will give this.

usage: marksman email [-h] exam

positional arguments:
  exam        exam uid

optional arguments:
  -h, --help  show this help message and exit

Examples

Visualize

Usage

Running marksman visualize --help will give this.

usage: marksman visualize [-h] [--r ROLL] exam

positional arguments:
  exam        exam uid

optional arguments:
  -h, --help  show this help message and exit
  --r ROLL    roll number of student (default=0 for all)

Examples

Utils

Usage

Running marksman utils --help will give this.

usage: marksman utils [-h] {dummy,import,export}

positional arguments:
  {dummy,import,export}
                        Choose the task you want to perform

optional arguments:
  -h, --help            show this help message and exit

Examples

Configuration

You can configure

API Reference

As marksman is written purely in python, it can easily be imported and extended by other Python programs.

Read the full API Reference which is published from the docstrings.