Metadata-Version: 1.0
Name: cqujwc
Version: 0.0.7
Summary: 重庆大学教务处登录模块
Home-page: https://github.com/maxoyed-MS/cqu_jwc
Author: maxoyed
Author-email: maxoyed@gmail.com
License: GPL License
Description: cqujwc
        ======
        
        重庆大学教务处登录模块
        
        1. 自动登录教务网
        
        2. 封装了带session的GET和POST请求，方便开发者使用
        
        3. 所有请求均加入了失败重试机制
        
        4. 获取当前登录用户姓名
        
        安装
        ----
        
        .. code:: bash
        
            pip install cqujwc
        
        使用
        ----
        
        .. code:: python
        
            from cqujwc import Student
            student = Student('学号', '密码')
        
        说明
        ----
        
        实例化\ ``Student``\ 对象时可选参数\ ``server``\ (默认为0):
        
        .. code:: text
        
            0: jxgl.cqu.edu.cn
            1: 202.202.1.41
            2: 202.202.1.176:8080
            3: 222.198.128.126
        
        利用当前session发起GET和POST请求
        --------------------------------
        
        GET
        ~~~
        
        .. code:: python
        
            student.get(url, params=None, headers=None)
        
        参数说明
        
        +-----------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
        | 参数名    | 说明                         | 备注                                                                                                                                                               |
        +===========+==============================+====================================================================================================================================================================+
        | url       | GET请求去掉server字段的url   | 例如，若要请求\ ``http://202.202.1.176:8080/MAINFRM.aspx``\ ，只需在实例化student对象时将\ ``server``\ 设置为2，然后调用\ ``student.get('/MAINFRM.aspx')``\ 即可   |
        +-----------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
        | params    | GET请求参数                  | 和requests.get()的params参数一致                                                                                                                                   |
        +-----------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
        | headers   | 请求头                       | 默认只有UA                                                                                                                                                         |
        +-----------+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
        
        POST
        ~~~~
        
        .. code:: python
        
            student.post(url, data=None, headers=None)
        
        参数说明
        
        +-----------+-------------------------------+-----------------------------------+
        | 参数名    | 说明                          | 备注                              |
        +===========+===============================+===================================+
        | url       | POST请求去掉server字段的url   | 同上                              |
        +-----------+-------------------------------+-----------------------------------+
        | data      | POST请求参数                  | 和requests.post()的data参数一致   |
        +-----------+-------------------------------+-----------------------------------+
        | headers   | 请求头                        | 默认只有UA                        |
        +-----------+-------------------------------+-----------------------------------+
        
        获取当前登录用户信息
        --------------------
        
        .. code:: python
        
            student.get_current_name()
        
        返回示例
        
        .. code:: json
        
            {
              "student_id": "学号",
              "name": "姓名"
            }
        
        获取入学以来每个学期的成绩
        --------------------------
        
        .. code:: python
        
            student.get_grade()
        
        返回示例
        
        .. code:: json
        
            {
              "total": {
                "name": "姓名",
                "student_id": "学号",
                "credit": "获得总学分",
                "GPA": "平均学分绩点",
                "no_pass": "未通过课程门数"
              },
              "items": [
                {
                  "name": "学期",
                  "courses": [
                    {
                      "name": "课程名称",
                      "credit": "学分",
                      "category": "类别",
                      "take_property": "修读性质",
                      "score": "成绩",
                      "notes": "备注"
                    }
                  ]
                }
              ]
            }
        
        统一认证
        --------
        
        .. code:: python
        
            from cqujwc import verify_auth
            verify_auth('统一认证号', '密码')
        
        验证成功返回\ ``True``\ ，失败返回\ ``False``
        
        开发计划
        --------
        
        -  获取成绩信息
        
        -  获取课表
        
        -  多服务器session管理
        
Keywords: spider cqu jwc
Platform: any
