/charusat-unofficial-api

CHARUSAT E-Governance UnOfficial API

Primary LanguagePythonMIT LicenseMIT

Logo

aditya76-git / charusat-unofficial-api

CHARUSAT UnOfficial API

Unofficial scraper for accessing student information from Charusat University's website.

Provides methods to interact with the university's website, retrieve student details, attendance, timetable, fees, and more.

📋Details

⚠️ Disclaimer

Please note that the charusat_scraper package is provided as-is and is not officially endorsed or supported by CHARUSAT. We have taken care to ensure that the package interacts with CHARUSAT Website in a secure and compliant manner

By using the charusat_scraper package, you acknowledge and agree that you are responsible for any actions taken with your CHARUSAT account, and you use the package at your own risk. We recommend using the package responsibly

We are not liable for any potential consequences that may arise from using the charusat_scraper package, including but not limited to account suspension, data loss, or any other issues related to your CHARUSAT account.

It's important to exercise caution and ensure that you keep your username, and password values private and secure.

The only way anyone can access your CHARUSAT account is by your Username and Password, so keep it safe with you. Refrain yourself from sharing with anyone else

📌 Note

Please note the following important information about the charusat_scraper package, which is a package for retrieving user data, including fees details, lecture gross attendance, attendance status, timetable, and other information:

This package empowers developers to harness its capabilities in creating insightful data representations, such as graphs and other visualizations, to gain deeper insights into attendance trends, fee structures, and other data.

  1. Security: Your E-governance account can only be accessed using your username and password. Please refrain from sharing your login credentials with anyone, as it could compromise the security of your account. Avoid pasting anything into your browser's developer tools, as this action could potentially expose your cookies to unauthorized parties.

  2. Usage: Ensure that you only use this package with the correct username and password. Repeatedly attempting to access your account with incorrect credentials may result in your account being temporarily blocked after five unsuccessful login attempts.

  3. Transparency: This is a complete open-source project, and developers are encouraged to review the code to confirm that there are no external servers or intermediaries involved.We want you to have full confidence in the security and transparency of this package. If you have any doubts, we welcome you to explore the codebase for reassurance, and if you still have concerns, we recommend refraining from using this repository.

  4. Data Security : This package interacts with the CHARUSAT E-Governance website in a manner similar to how a regular user would do using their mobile or PC. It performs actions programmatically and allows you to conveniently obtain useful parsed data, ensuring a safe and familiar browsing experience.

We encourage responsible and secure use of this package for accessing and managing your educational information.

⚙️Installation

Open your terminal or command prompt and enter the following command:

pip install git+https://github.com/aditya76-git/charusat-unofficial-api@main

Note: To use this package you need to have a Active Charusat E-Governance Account

🚀Initialization

Initialize an instance of the CharusatScraper class by providing your Charusat E-Governance username and password as arguments. Replace "YOUR_USERNAME" and "YOUR_PASSWORD" with your actual Charusat login credentials.

from charusat_scraper import CharusatScraper
scraper = CharusatScraper("YOUR_USERNAME", "YOUR_PASSWORD")

➡️ Get User Details

Get User information and Previous Exam Details of the authenticated User

scraper.get_user_details()

Sample Result

{
    "user_info": {
        "id": "21CE00",
        "registrationDate": "24/09/2021",
        "admissionDate": "24/09/2021",
        "displayName": "DISPLAY NAME",
        "gender": "Male",
        "nationality": "INDIAN",
        "motherTongue": "HINDI",
        "birthDate": "00/00/0000",
        "birthplace": "PLACE",
        "address": "ADDRESS"
    },
    "previous_exam_details": [
        {
            "exam": "SSC",
            "seatNo.": "000000",
            "cgpa_percentageObtained": "85.4",
            "percentile": "0.00",
            "year": "2019",
            "month": "MAY",
            "board_University": "C.B.S.E",
            "group_Specialisation": "GENERAL"
        },
        {
            "exam": "HSC",
            "seatNo.": "000000",
            "cgpa_percentageObtained": "72.6",
            "percentile": "0.00",
            "year": "2021",
            "month": "MAY",
            "board_University": "C.B.S.E",
            "group_Specialisation": "SCIENCE (A GROUP)"
        }
    ]
}

➡️ Get Lecture Gross Attendance

Get Gross Lecture Attendance information of the authenticated User

scraper.get_attendance()

Sample Result

[
    {
        "courseCode": "CE391 / PDA",
        "courseName": "PYTHON FOR DATA ANALYTICS",
        "classType": "LECT",
        "attendance": "12/15",
        "percentage": "80%"
    },
    {
        "courseCode": "CE391 / PDA",
        "courseName": "PYTHON FOR DATA ANALYTICS",
        "classType": "LAB",
        "attendance": "4/5",
        "percentage": "80%"
    },
    {
        "courseCode": "EE342 / SDCM",
        "courseName": "SYNCHRONOUS AND DC MACHINES",
        "classType": "LECT",
        "attendance": "20/26",
        "percentage": "76%"
    },
    {
        "courseCode": "EE342 / SDCM",
        "courseName": "SYNCHRONOUS AND DC MACHINES",
        "classType": "LAB",
        "attendance": "8/13",
        "percentage": "61%"
    },
    {
        "courseCode": "EE351 / EPTD",
        "courseName": "ELECTRICAL POWER TRANSMISSION AND DISTRIBUTION",
        "classType": "LECT",
        "attendance": "11/15",
        "percentage": "73%"
    },
    {
        "courseCode": "EE353 / PED-I",
        "courseName": "POWER ELECTRONICS AND DRIVES - I",
        "classType": "LECT",
        "attendance": "31/34",
        "percentage": "91%"
    },
    {
        "courseCode": "EE353 / PED-I",
        "courseName": "POWER ELECTRONICS AND DRIVES - I",
        "classType": "LAB",
        "attendance": "7/11",
        "percentage": "63%"
    },
    {
        "courseCode": "EE375 / ECAM",
        "courseName": "ENERGY CONSERVATION, AUDIT AND MANAGEMENT",
        "classType": "LECT",
        "attendance": "16/24",
        "percentage": "66%"
    },
    {
        "courseCode": "EE375 / ECAM",
        "courseName": "ENERGY CONSERVATION, AUDIT AND MANAGEMENT",
        "classType": "LAB",
        "attendance": "1/5",
        "percentage": "20%"
    },
    {
        "courseCode": "HS131.02 A / HS-5",
        "courseName": "COMMUNICATION AND SOFT SKILLS",
        "classType": "LAB",
        "attendance": "8/10",
        "percentage": "80%"
    }
]

➡️ Get Attendance Status

Get Attendance Status of the authenticated User

scraper.get_attendance_status()

Sample Result

[
    {
        "time": "10:10 - 11:09",
        "faculty": "FACULTY NAME",
        "courseCode": "0000 / SDCM",
        "courseName": "SYNCHRONOUS AND DC MACHINES",
        "attendanceStatus": "P"
    },
    {
        "time": "12:10 - 14:09",
        "faculty": "FACULTY NAME",
        "courseCode": "0000 / ECAM",
        "courseName": "ENERGY CONSERVATION, AUDIT AND MANAGEMENT",
        "attendanceStatus": "NT"
    },
    {
        "time": "16:20 - 17:19",
        "faculty": "FACULTY NAME",
        "courseCode": "0000 / PDA",
        "courseName": "PYTHON FOR DATA ANALYTICS",
        "attendanceStatus": "A"
    }
]

➡️ Get Fees Details

Get Fees Details of the authenticated User

scraper.get_fees_details()

Sample Result

[
    {
        "semester": "5",
        "totalFees": "00000.00",
        "recievedFees": "00000.00",
        "scholarshipAmount": "0.00",
        "pendingFees": "0.00"
    },
    {
        "semester": "4",
        "totalFees": "00000.00",
        "recievedFees": "00000.00",
        "scholarshipAmount": "0.00",
        "pendingFees": "0.00"
    },
    {
        "semester": "3",
        "totalFees": "00000.00",
        "recievedFees": "00000.00",
        "scholarshipAmount": "0.00",
        "pendingFees": "0.00"
    },
    {
        "semester": "2",
        "totalFees": "00000.00",
        "recievedFees": "00000.00",
        "scholarshipAmount": "0.00",
        "pendingFees": "0.00"
    },
    {
        "semester": "1",
        "totalFees": "00000.00",
        "recievedFees": "00000.00",
        "scholarshipAmount": "0.00",
        "pendingFees": "0.00"
    }
]

➡️ Get Result Details (To-Do)

The inclusion of __VIEWSTATE, __VIEWSTATEGENERATOR, and __EVENTVALIDATION in the payload is currently ineffective, rendering this method non-functional at the moment.

Get Result Details of the authenticated User

scraper.get_result_data()

Sample Result

{
    "result": [
        {
            "courseName": "ENGINEERING MECHANICS",
            "courseType": "THEORY",
            "credit": "3.00",
            "grade": "AA"
        },
        {
            "courseName": "ENGINEERING MECHANICS",
            "courseType": "PRACTICAL",
            "credit": "1.00",
            "grade": "AB"
        },
        {
            "courseName": "ENVIRONMENTAL SCIENCES",
            "courseType": "PRACTICAL",
            "credit": "2.00",
            "grade": "AB"
        },
        {
            "courseName": "FOUNDATION COURSE ON MATHEMATICS AND PHYSICS",
            "courseType": "PRACTICAL",
            "credit": "2.00",
            "grade": "AA"
        },
        {
            "courseName": "COMMUNICATIVE ENGLISH",
            "courseType": "PRACTICAL",
            "credit": "2.00",
            "grade": "AB"
        },
        {
            "courseName": "ENGINEERING MATHEMATICS-I",
            "courseType": "THEORY",
            "credit": "4.00",
            "grade": "AA"
        },
        {
            "courseName": "WORKSHOP PRACTICES",
            "courseType": "PRACTICAL",
            "credit": "1.00",
            "grade": "AA"
        },
        {
            "courseName": "ENGINEERING GRAPHICS",
            "courseType": "THEORY",
            "credit": "2.00",
            "grade": "AB"
        },
        {
            "courseName": "ENGINEERING GRAPHICS",
            "courseType": "PRACTICAL",
            "credit": "1.00",
            "grade": "AA"
        },
        {
            "courseName": "ENGINEERING PHYSICS-I",
            "courseType": "PRACTICAL",
            "credit": "2.00",
            "grade": "BB"
        }
    ],
    "summary": [
        {
            "semester": "1",
            "month_year": "February 2022",
            "totalCredits": "20.00",
            "creditsEarned": "20.00",
            "sgpa": "9.45"
        }
    ],
    "student_info": {
        "name": "NAME",
        "id": "21CE000"
    }
}

🌟 Show Your Support

  • If you find this project useful or interesting, please consider giving it a star on GitHub. It's a simple way to show your support and help others discover the project.

Github Stars

👨‍💻Developement

Thank you for your interest in contributing to this project! There are several ways you can get involved:

  • Opening Issues: If you encounter a bug, have a feature request, or want to suggest an improvement, please open an issue. We appreciate your feedback!
  • Cloning the Project: To work on the project locally, you can clone the repository by running:
git clone https://github.com/aditya76-git/charusat-unofficial-api.git
  • Sending Pull Requests: If you'd like to contribute directly to the codebase, you can fork the repository, make your changes, and then send a pull request. We welcome your contributions!

💻Authors