marksman 0.6.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.

In modern times most applications have a Graphical User Interface ( GUI ).

To use a GUI app we can easily see stuff on the screen and click or give input wherever required.

But in the early days of computing, computers were mostly text-based, ie input used to be provided through the keyboard and the output ( some plain text ) was displayed on the screen.

Command-line applications are run from the Terminal. In all Unix based OS like Mac or Linux, the terminal is installed by default. For Windows you have a command prompt. You can also install the Windows Terminal (which has much more features than the command prompt)

Let us familiarize ourselves with some basic terminology.

A command-line application has basically 3 things:

1. name : name by which you call the app
2. positional arguments: required inputs for app
3. optional arguments: optional configurations for running the app

The usage of a command-line application is expressed by a syntax where certain symbols have special meanings. Lets see some common expressions:

1. | : or
2. [] : optional argument
3. {} : any one of

A command-line app is called by its name from the terminal. Open your terminal and write some commands and press enter. You will see the output displayed.

You can issue a command like this:

program [arguments]

Here program is the name of the app, and [] symbolizes that the arguments are optional. The arguments are obviously different for every application.

Lets understand better by taking some examples:

Open you terminal and enter ls ( for Unix-based OS ) or dir for Windows.

You will see the contents of you current directory as output.

Now if you want to clear your terminal, enter clear or cls (Windows).

Till this point the applications we used, did not take any argument.

Now lets take the example of copying a file:

Continue reading, but use copy for Windows instead of cp.

In the following example the file a.txt will be copied to the Documents directory.

cp a.txt Documents

In the above example a.txt and Documents are positional arguments.

Now run cp --help, you will know all the positional and optional arguments that cp accepts. Here --help is an optional argument.

Learn more about the common operations from the command-line.

Note: File paths in Windows and Unix look different. Search Google or YouTube to learn more.

You will be happy to know that marksman is cross-platform and its usage is consistent across all operating systems.

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.