JEE Counsellor

A command-line tool for JEE counselling assistance.

Introduction

JEE Counsellor is a Python-based tool designed to assist with the counselling process for JEE (Joint Entrance Examination). It provides information about different rounds of counselling, institutes, programs, and closing ranks based on user input. This tool aims to simplify the decision-making process for JEE aspirants by providing relevant data.

Features

• Dual Counselling Support: Get data for both JOSAA and CSAB counselling rounds.
• Comprehensive Filters: Filter results by institute type (IIT, NIT, IIIT, GFTI), specific institutes, and programs.
• Rank-Based Analysis: Input your rank to see relevant closing ranks and college options.
• User-Friendly Interface: A simple and interactive command-line interface for easy navigation.
• Cross-Platform: Run the tool on Windows, macOS, Linux, and even Termux on Android.

Table of Contents

• Installation
  • Through Executable (Fast to install and setup, but slow to execute.)
    • Windows
    • Mac
    • Linux
  • Cloning from the Source (Recommended)
    • Windows
    • Mac
    • Linux
    • Termux Instructions
• Dependencies
• Usage
• License
• Credit

Installation

Executable (Might be Slow)

The JEE Counsellor tool is available as an executable for Windows, Mac, and Linux. Follow the instructions below to run the tool on your respective operating system.

Note: The provided installation method is only compatible with the x86_64 architecture. It will not work on other architectures.

Windows

• Download the jcounsellor.exe executable file from the latest release.

• Before running the tool, Windows may display a security warning message that prevents the execution of the tool. This is a precautionary measure to ensure the safety of your system. However, since jcounsellor is an open-source tool, you can bypass this security check and run the tool.

  • Here are two methods to bypass the security check:

    • Method 1: Use the "Run Anyway" option

      • When the security warning message appears, click on the "More info" link.
      • A new option "Run Anyway" should appear. Click on it to run the tool.

    • Method 2: Unblock the file

      • Right-click on the jcounsellor.exe file.
      • Select "Properties" from the context menu.
      • In the Properties window, locate and click on the "Unblock" button, if available.
      • Click "Apply" and then "OK" to save the changes.

    • By choosing the "Run Anyway" option or unblocking the file, you are indicating that you trust the source and intend to run the tool on your system.

    • Double-click the jcounsellor.exe file to run the tool. You should now be able to launch and use jcounsellor without any issues.

Note: Please understand that obtaining a license for commercial software can be expensive, and as an open-source tool, jcounsellor does not require any license fees. This allows us to provide the tool free of charge. However, it also means that we may not be able to offer the same level of support or additional features as commercial alternatives.

Mac

Note: The provided installation method is only compatible with the x86_64 architecture. It will not work on other architectures.

• Download the jcounsellor executable file from the latest release.

• Open the Terminal application.

• Navigate to the directory where the jcounsellor file is located using the cd command. For example, if the file is in the Downloads folder, use the following command:

  cd ~/Downloads

• Make the file executable by running the following command:

  chmod +x jcounsellor

• Run the tool using the following command:

  ./jcounsellor

Linux

Note: The provided installation method is only compatible with the x86_64 architecture. It will not work on other architectures.

• Download the jcounsellor executable file from the latest release.

• Open the Terminal application.

• Navigate to the directory where the jcounsellor file is located using the cd command. For example, if the file is in the Downloads folder, use the following command:

  cd ~/Downloads

• Make the file executable by running the following command:

  chmod +x jcounsellor

• Run the tool using the following command:

  ./jcounsellor

Cloning from the Source (Recommended)

This is the recommended installation method. While it requires a few more steps (installing Python and Git), it offers several key advantages:

• Faster Execution: The script runs directly using your system's Python interpreter, which is significantly faster than the packaged executable.
• Latest Updates: You get access to the most recent code changes and bug fixes instantly.
• Contribution Ready: This setup allows you to easily contribute to the project's development.

Cloning from the Source ( Windows )

Prerequisites

Before cloning the repository and running the tool, ensure that you have the following software installed on your Windows system:

• Python 3.x
• Git

Steps

• Install Python:

  • Download the latest version of Python 3.x from the official Python website: Download Python.
  • Run the installer and follow the installation instructions.
  • Make sure to select the option to add Python to your system's PATH during the installation process.

• Install Git:

  • Download Git for Windows from the official Git website: Download Git.
  • Run the installer and follow the installation instructions.
  • During the installation, you can choose the default options unless you have specific preferences.

• Clone the repository:

  • Open the Command Prompt (CMD) or Git Bash.
  • Navigate to the directory where you want to clone the repository using the cd command. For example, to clone the repository into the current directory, use:

    cd /path/to/desired/directory

  • Clone the repository using the following command:

    git clone https://github.com/ksauraj/jee_counsellor.git

• Navigate to the project directory:

  • Change the current directory to the cloned repository:

    cd jee_counsellor

• Create a Virtual Environment:

  • creating a virtual environment to avoid conflict with os distribution package manager:

     python -m venv venv

• Activate the virtual environment:

  • Activating that venv in the directory:

     venv\Scripts\activate

• Install the dependencies:

  • Install the required dependencies using the following command:

    pip install -r requirements.txt

• Run the tool:

  • Launch the JEE Counsellor tool using the following command:

    python tool.py

Cloning from the Source (Linux / Mac )

• Ensure that you have Python 3.x installed on your system.
• Clone the repository:

git clone https://github.com/ksauraj/jee_counsellor.git

• Navigate to the project directory:

cd jee_counsellor

• Create a Virtual Environment:

 python -m venv venv

• Activate the virtual environment:

 source venv/bin/activate

• Install the dependencies:

pip install -r requirements.txt

• Run the tool:

python tool.py

Termux Instructions:

• Clone the repository (if git isn't installed use pkg install git):

git clone https://github.com/ksauraj/jee_counsellor.git

• Navigate to the project directory:

cd jee_counsellor

• Install python if it isn't installed using:

pkg install -y python

• Sometimes libexpat.so is missing, so to avoid any issues later install it using:

pkg install libexpat

• Install python-numpy and python-pandas which is under tur-repo:

pkg install python-numpy
pkg install tur-repo
pkg install python-pandas

• Install the last dependency:

pip install colorama

• Now you can run the tool using:

python tool.py

Dependencies

The following dependencies are required to run JEE Counsellor:

• Python 3.x
• pandas
• colorama

You can install the required dependencies using the following command:

pip install -r requirements.txt

Usage

After successfully installing the tool, follow these steps to run it:

1. Launch the tool from your terminal:

   • If installed from source: python tool.py
   • If using the executable: ./jcounsellor (for Linux/Mac) or double-click the .exe (for Windows).

2. Follow the on-screen prompts:

   • Select the counselling year.
   • Choose the counselling type (e.g., JOSAA or CSAB).
   • Select the round number.
   • Choose the institute type (e.g., IIT, NIT).
   • Select the program(s) you are interested in.
   • Enter your rank and category.

3. View the results: The tool will process your query and automatically open the results in a new tab in your default web browser.

jee_counsellor_tut.mp4

Contributing

• Fork the repo
• Create a feature branch
• Commit your changes
• Open a Pull Request

License

This project is licensed under the GNU General Public License v3.0. For more details, see the LICENSe file.

Credit

• This project has been developed by Ksauraj.