Skip to content

A portable command line tool that creates and manages simple academic journals

Notifications You must be signed in to change notification settings

Vaccarini-Lorenzo/Academic-Journal-Builder

Repository files navigation

Academic Journal Builder📕   credits

This simple command line tool allows to automate the whole process of grade journaling, managing a Github repository to store and document your academic journey.

intro

What you need

  • A github repository to store your Academic Journal
  • A valid SSH key for your GitHub account
  • Python 3

Installation

In order to install the Academic Journal Builder, just clone the repository and execute the install.sh file.

cd <path_to_cloned_repo> && ./install.sh

Usage

  1. Enter your repository link and matricola through the flags --repo and --code

addRepoAndMatricola

  1. [Optional] Add you course of study using the flag --course-of-study

courseOfStudy

  1. That's it! Just add your first grade. You can either:

Add only the grade specifying the numeric value of the grade and the course name with the flags --name and --grade

addGrade

Add a grade file and the course name with the flags a --name and --path. This way a CourseNameStats.md file with the exam statistics will be created

addFile

How to format the grade file

The expected txt file is in the form

Matricola Grade ... ...

With each colon divided by a tab \t

How to obtain the grade file

Just go to Servizi Online > Consultazione Esito Esami, click on the grade you want to register, access the grade list and copy-paste it on a file.txt

About

A portable command line tool that creates and manages simple academic journals

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published