pera-transcript 0.2.0
A tool to generate the unofficial transcript automatically for undergraduate students at University of Peradeniya.
License: MIT License

# Auto-Generate Tool for eng.pdn.ac.lk Interim Transcript Template (Unofficial)

## Installation

```
pip install pera-transcript
```

## Using the tool

1. Generate the latex file: 

  The tool provides three ways of specifying metadata in order to generate the latex file. Choose any of the following methods that you find convenient.

  - Specify metadata as a set of command-line arguments:
    ```bash
    autogen_transcript --user "E/XX/YYY" --passwd "password" --DOB "DD Month YYYY" --dept_head "Prof. John A. Doe"
    ```

  - Using a "metadata.yml" file: Create a "metadata.yml" file with your registeration number, course registeration portal password, your date of birth, and the name of your head of department as following:

    ```yaml
    user: E/XX/YYY # Your registeration number
    passwd: xxxxxx # Your password for the course registeration / degree claim account
    DOB: DD Month YYYY # Your date of birth
    dept_head: Prof. John A. Doe # The name of your head of department
    ```

    Then, run the tool as follows:

    ```bash 
    autogen_transcript --meta_path="/path/to/metadata.yml"
    ```

  - Specify the metadata as a JSON formatted string in the command-line argument:

    If using Windows,
    ```bash
    autogen_transcript --meta_cfg "{\"user\": \"E/XX/YYY\", \"passwd\": \"password\", \"DOB\": \"DD Month YYYY\", \"dept_head\": \"Prof. John A. Doe\"}"
    ```

    If using Linux,
    ```bash
    autogen_transcript --meta_cfg '{"user": "E/XX/YYY", "passwd": "password", "DOB": "DD Month YYYY", "dept_head": "Prof. John A. Doe"}'
    ```

2. Generate both latex and pdf files:

  ```bash 
  autogen_transcript --compile (--meta_path META_PATH | --meta_cfg META_CFG | --user USER --passwd PASSWD --DOB DOB --dept_head DEPT_HEAD)
  ```

* The [latex template](https://github.com/cepdnaclk/eng.pdn.ac.lk-unofficial-interim-transcript-template) used in this tool was originally created for the convinience of obtaining interim transcripts by [@samurdhilbk](https://github.com/samurdhilbk).

* You **must** get the interim transcript approved with the signature and seal of the head of the department.

* **Frequently Asked Questions**
  * Can I add or drop technical electvies when I am filling this?
  * Should I round off/up/down my GPA? --- the python script rounds up to the nearest 0.05
  * How can I mention me completing the internship even when TR400 results are not officially released?
  * The previous semester results are not added to the degree claim page. Can I add them to this transcript? 

  **Answer to all FAQs:** Ask the head of your department.
  
* **Disclaimer:** The creator(s) do not take any responsibility for how you ue this template or what you run into in the process, including but not limited to:
  * Head of department declining to approve this template.
  * Any institution declining to accept this unofficial transcript.
  * Mistakes you make while filling your information.
  * You intentionally filling fake information.
  * Someone using the logo or any other information in this document for any malicious purpose.