> For the complete documentation index, see [llms.txt](https://liuxingran.gitbook.io/hdu-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://liuxingran.gitbook.io/hdu-api/apis/create.md).

# hdu\_api

此章节是关于如何创建一个 client 的描述。

## `HDU` Objects

[`HDU`](/hdu-api/apis/create.md#hdu-objects) 对象是使用 `hdu-api` 的起点，它提供了创建 `HduClient` 对象的方法。

**Constructor**:

*class* hdu\_api.**HDU**(*username, password, \*\*kwargs*)

|    参数    | type | required | default |  备注 |
| :------: | :--: | :------: | :-----: | :-: |
| username |  str |   true   |    无    |  学号 |
| password |  str |   true   |    无    |  密码 |
|  kwargs  | dict |   false  |    无    |     |

**Class methods**:

* *classmethod* HDU.**create**(*\*args*)

    返回一个 `HduClient` 对象。

**Class attributes**:

* HDU.**username**

    学号，字符串类型。
* HDU.**password**

    密码，数字杭电的密码，字符串类型。

## `HduClient` Objects

[`HduClient`](/hdu-api/apis/create.md#hduclient-objects) 对象提供了对 API 访问的通道。

**Constructor**:

*class* hdu\_api.**HduClient**(*sess\_mgr, \*\*kwargs*)

|     参数    |           type           | required | default |  备注 |
| :-------: | :----------------------: | :------: | :-----: | :-: |
| sess\_mgr | objects `SessionManager` |   true   |    无    |     |
|   kwargs  |           dict           |   false  |    无    |     |

**Class methods**:

**Class attributes**:

* HduClient.**sess\_mgr**

    `SessionManager` 对象，提供了 session 管理。
* HduClient.**username**

    学号，字符串类型。
* HduClient.**card**

    `Card` 对象，提供了对一卡通 API 的访问，详情请查看[这里](/hdu-api/apis/card.md)。
* HduClient.**exam**

    `Exam` 对象，提供了对考试 API 的访问，详情请查看[这里](/hdu-api/apis/exam.md)。
* HduClient.**person**

    `Person` 对象，提供了对个人信息 API 的访问，详情请查看[这里](/hdu-api/apis/person.md)。
* HduClient.**course**

    `Course` 对象，提供了对课程 API 的访问，详情请查看[这里](/hdu-api/apis/course.md)。
* HduClient.**public**

    `Public` 对象，提供了对公共信息 API 的访问，详情请查看[这里](/hdu-api/apis/public.md)。