Skip to main content

The Python TJU client — scrapes TJU SSO + EAMS for structured academic data

Project description

TJU The Python TJU client

PyPI version CI Docs License: GPL v3

English | 简体中文

Beta release (v0.1.0). The API is functional; minor breaking changes may occur before v1.0.

tju is a Python library that logs into Tianjin University's SSO and EAMS systems and returns structured academic data. It handles CAS authentication, CAPTCHA solving (via ddddocr), and HTML parsing — so your code just calls methods and gets typed objects back.

Network requirement: All live API calls require an active connection to the TJU campus network or VPN (sso.tju.edu.cn / classes.tju.edu.cn).

Features

Feature Client method
Student profile client.profile
Personal timetable client.schedule(semester)
Public course library client.query_courses(semester)
Course detail client.query_course_info(lession_id)
Course syllabus client.query_syllabus(lession_id)
Exam schedule client.exam(semester)
Scores (UG + GS) client.score()
Experiment scores client.exp_score(semester)
Free classroom search client.free_classrooms(date_begin, ...)

Installation

pip install tju

From source (recommended for development):

git clone https://github.com/superpung/tju-python.git
cd tju-python
uv sync       # installs all dependencies into .venv

Quick start

Set your credentials as environment variables (or put them in a .env file):

export TJU_USER=your_student_id
export TJU_PASS=your_password
from tju.client import create_client

client = create_client()   # reads TJU_USER / TJU_PASS from env
print(client.profile)
print(client.schedule(semester="24251"))

Runnable examples:

# Personal timetable — prints your courses and saves JSON
uv run --env-file .env python examples/fetch_schedule.py

# Full course library (UG + GS) — crawls all pages and saves JSON
uv run --env-file .env python examples/fetch_all_courses.py

Both scripts write output to examples/output/ (gitignored).

Usage

from tju import Session
from tju.client import Client

session = Session()                              # or: Session(username=..., password=...)
client  = Client(session=session)

# Identity
client.stu_id        # student ID string
client.stu_name      # name string
client.stu_type      # StuType.UNDERGRADUATE | StuType.GRADUATE
client.has_minor     # bool
client.semester      # current semester code, e.g. "24252"

# Data
client.profile
client.schedule(semester="24251")
client.query_courses(semester="24251")
client.query_course_info(lession_id="387248")
client.query_syllabus(lession_id="387248")
client.exam(semester="24251")
client.score()
client.exp_score(semester="20211")
client.free_classrooms(date_begin="2025-10-08", campus_id=3)

Semester codes follow the EAMS convention, e.g. "24251" = 2024–2025 first term, "24252" = 2024–2025 second term. See src/tju/consts.py for the full SEMESTER map.

Development

uv sync          # install runtime + dev dependencies
uv run pytest    # run the offline test suite (30 tests, no network required)

See CONTRIBUTING.md for architecture details and the fixture privacy rule. See AGENTS.md for AI-agent contributor guidance.

Documentation

Full API reference and usage guides: https://superpung.github.io/tju-python/

To build the docs locally:

uv sync --group docs
uv run mkdocs serve

License

GPLv3 License © 2023-PRESENT Super Lee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tju-0.1.0.tar.gz (273.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tju-0.1.0-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

Details for the file tju-0.1.0.tar.gz.

File metadata

  • Download URL: tju-0.1.0.tar.gz
  • Upload date:
  • Size: 273.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tju-0.1.0.tar.gz
Algorithm Hash digest
SHA256 03cb1b43dda12a395418920490b8cc16e2f1b0af2eebf511aab033fab1a1bfd4
MD5 b07ec02a0227276232ea3c4651373500
BLAKE2b-256 771b722d85fa86acf849fea44e318635d735e5b34b01ccb62b1c88e3c4a0150a

See more details on using hashes here.

Provenance

The following attestation bundles were made for tju-0.1.0.tar.gz:

Publisher: publish.yml on superpung/tju-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tju-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tju-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tju-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4a3e759365330431aa5ee0035b8515de390e9721d18ee0924580ef66c004c91
MD5 faa05583b73c8aa35a2ae78e08e3826e
BLAKE2b-256 176fa0d980322af56cbb0f4930f627f561df447e5ec00e63b7692260018bfe77

See more details on using hashes here.

Provenance

The following attestation bundles were made for tju-0.1.0-py3-none-any.whl:

Publisher: publish.yml on superpung/tju-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page