getting started

Install pyjiit 0.1.0a8, log in with a Captcha, and pull attendance. Deeper install notes: Installation. Copy-paste walkthrough: Quick start guide. Login internals: Authentication flow.

End users install from PyPI. Maintainers use Poetry.

flowchart LR
  Py["Python 3.9+"] --> Pip["pip install pyjiit"]
  Pip --> Lib["requests plus pycryptodome"]
  Lib --> API["StudentPortalAPI"]

pip install pyjiit

That pulls the two runtime deps. There is no README.md. Package metadata is in README.rst and pyproject.toml.

from pyjiit import Webportal
from pyjiit.default import CAPTCHA

w = Webportal()
print(w)
# Driver Class for JIIT Webportal

session = w.student_login("username", "password", CAPTCHA)
print(session.clientid)
# JAYPEE

CAPTCHA is a filled Captcha in pyjiit.default. The Sphinx usage page says the portal does not really bind captcha state to your IP, so the premade object is what people actually ship.

To fetch a live image instead:

from pyjiit import Webportal

w = Webportal()
captcha = w.get_captcha()
# captcha.image is a base64 PNG
# set captcha.captcha to the text, then student_login(...)

flowchart TD
  I["pip install pyjiit"] --> W["Webportal()"]
  W --> C["CAPTCHA or get_captcha"]
  C --> L["student_login"]
  L --> M["get_attendance_meta"]
  M --> A["get_attendance"]

meta = w.get_attendance_meta()
header = meta.latest_header()
sem = meta.latest_semester()
print(w.get_attendance(header, sem))

get_attendance can take more than 10 seconds. That wait is the portal.

semesters = w.get_registered_semesters()
reg = w.get_registered_subjects_and_faculties(semesters[0])
print(*reg.subjects, sep="\n")
print(reg.total_credits)

from pyjiit.exceptions import NotLoggedIn, LoginError, APIError

w = Webportal()
try:
    w.get_student_bank_info()
except NotLoggedIn:
    pass

Call student_login before any @authenticated method. Bad credentials raise LoginError. Generic portal failures raise APIError.

flowchart LR
  NoSess["no student_login"] --> NL["NotLoggedIn"]
  Bad["bad user/pass/captcha"] --> LE["LoginError"]
  Fail["responseStatus not Success"] --> API["APIError"]

• There is no logout.
• The class is Webportal, not WebPortal.
• The client is requests, not fetch.
• Webportal() does not take a cached WebportalSession. README.rst still lists that as a roadmap item.