Skip to content

Commit 15fb5a4

Browse files
ZhaoQi99ZhaoQi99
committed
docs(README): Update README.md
2 parents c31ff50 + b52bc89 commit 15fb5a4

File tree

1 file changed

+118
-118
lines changed

1 file changed

+118
-118
lines changed

‎README.md‎

Lines changed: 118 additions & 118 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,118 @@
1-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a631e0b7b3484ecf8cf3226b8f0d90b9)](https://app.codacy.com/app/ZhaoQi99/SNNU-SDK?utm_source=github.com&utm_medium=referral&utm_content=snnucs/SNNU-SDK&utm_campaign=Badge_Grade_Settings)
2-
[![Build Status](https://travis-ci.com/snnucs/SNNU-SDK.svg?branch=dev)](https://travis-ci.com/snnucs/SNNU-SDK)
3-
[![image](https://img.shields.io/pypi/v/snnusdk.svg)](https://pypi.org/project/snnusdk/)
4-
[![Release](https://img.shields.io/github/release/ZhaoQi99/SNNU-SDK.svg)](https://github.com/ZhaoQi99/SNNU-SDK/releases)
5-
[![image](https://img.shields.io/pypi/pyversions/snnusdk.svg)](https://pypi.org/project/snnusdk/)
6-
[![Documentation Status](https://readthedocs.org/projects/snnu-sdk/badge/?version=dev)](https://snnu-sdk.readthedocs.io/zh_CN/dev/?badge=dev)
7-
[![GitHub license](https://img.shields.io/github/license/ZhaoQi99/SNNU-SDK.svg)](https://github.com/ZhaoQi99/SNNU-SDK/blob/dev/LICENSE)
8-
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/snnucs/SNNU-SDK.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/snnucs/SNNU-SDK/context:python)
9-
10-
11-
# 陕西师范大学(SNNU) 第三方Python SDK
12-
---
13-
SNNU-SDK 是陕西师范大学(SNNU)的一个第三方Python-SDK，实现了校内常用服务如教务处、图书馆、校园卡、教室查询等接口的Python封装。
14-
15-
## 功能
16-
### Urp教务系统
17-
- 本学期课表
18-
- 历年课表
19-
- 本学期成绩
20-
- 历年考试成绩
21-
- 必修课绩点
22-
23-
### 图书馆
24-
- 基本信息
25-
- 在借书籍
26-
- 预约书籍
27-
- 现金事务
28-
- 挂失、解挂图书证
29-
- 预约到馆信息
30-
31-
### 教室
32-
- 某教学楼的所有教室号
33-
- 某教学楼某周的所有教室的状态
34-
- 某教学楼某周某一教室的状态
35-
36-
### 校园卡
37-
- 校园卡消费明细
38-
- 校园卡余额
39-
- 校园卡照片
40-
41-
### 通知新闻
42-
- 某部门的最新通知
43-
- 某部门的最新新闻
44-
- 所支持的部门
45-
46-
## 安装
47-
### 安装snnusdk
48-
```bash
49-
pip install snnusdk
50-
✨🍰✨
51-
52-
```
53-
### (可选)安装Tesseract-OCR
54-
如需正常使用Urp教务系统相关功能，需安装OCR识别引擎
55-
- [Windows](https://github.com/tesseract-ocr/tesseract/wiki#windows)
56-
- [Linux](https://github.com/tesseract-ocr/tesseract/wiki#linux)
57-
- [Mac OS](https://github.com/tesseract-ocr/tesseract/wiki#macos)
58-
## 使用示例
59-
这里是一些简单的使用案例
60-
```Python
61-
from snnusdk import Urp
62-
urp = Urp(account='B11111111', password='xxx')
63-
64-
>>> urp.getCourses()
65-
[
66-
{
67-
'id': '1241416',
68-
'name': '算法设计与分析',
69-
'number': '01',
70-
'credits': 3.0,
71-
'attributes': '必修',
72-
'teacher': '王小明*',
73-
'status': '置入',
74-
'info': [
75-
{
76-
'week': '1-18周上',
77-
'day': '2',
78-
'timeOfClass': '1',
79-
'numOfClass': '2',
80-
'campus': '长安校区',
81-
'buildings': '长安文津楼',
82-
'room': '1511'
83-
}
84-
]
85-
}
86-
]
87-
88-
from snnusdk import Libiary
89-
libiary = Library(username='B11111111', password='xxx')
90-
91-
>>> library.getInfo()
92-
{
93-
'帐号ID': '2016xxxxx',
94-
'姓名': '张三',
95-
'昵称': 'xx',
96-
'登录次数': '123',
97-
'状态': '正常'
98-
}
99-
```
100-
101-
## 文档
102-
你可以在[https://snnucs.github.io/SNNU-SDK](https://snnucs.github.io/SNNU-SDK)看到本项目的完整使用文档。
103-
104-
## 贡献你的代码
105-
欢迎您贡献出自己的一份力量，你可以随时提交`issue`或`fork`本仓库,静候你的`pull request`。
106-
107-
## 贡献者
108-
感谢所有对本项目做出过贡献的开发者([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
109-
110-
111-
| [<img src="https://avatars3.githubusercontent.com/u/40024866?v=4" width="100px;"/><br /><sub><b>jhy</b></sub>](https://Small-funny.github.io/)<br />[💻](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=Small-funny "Code") [📖](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=Small-funny "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/7782671?v=4" width="100px;"/><br /><sub><b>Keyi Xie</b></sub>](https://xiekeyi98.github.io/)<br /> [📖](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=xiekeyi98 "Documentation") |
112-
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
113-
114-
## 谁在使用
115-
116-
## 开源协议 & 作者
117-
* 作者:Qi Zhao([zhaoqi99@outlook.com](mailto:zhaoqi99@outlook.com))
118-
* 开源协议:[GNU General Public License v3.0](https://github.com/ZhaoQi99/SNNU-SDK/blob/dev/LICENSE)
1+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a631e0b7b3484ecf8cf3226b8f0d90b9)](https://app.codacy.com/app/ZhaoQi99/SNNU-SDK?utm_source=github.com&utm_medium=referral&utm_content=snnucs/SNNU-SDK&utm_campaign=Badge_Grade_Settings)
2+
[![Build Status](https://travis-ci.com/snnucs/SNNU-SDK.svg?branch=dev)](https://travis-ci.com/snnucs/SNNU-SDK)
3+
[![image](https://img.shields.io/pypi/v/snnusdk.svg)](https://pypi.org/project/snnusdk/)
4+
[![Release](https://img.shields.io/github/release/ZhaoQi99/SNNU-SDK.svg)](https://github.com/ZhaoQi99/SNNU-SDK/releases)
5+
[![image](https://img.shields.io/pypi/pyversions/snnusdk.svg)](https://pypi.org/project/snnusdk/)
6+
[![Documentation Status](https://readthedocs.org/projects/snnu-sdk/badge/?version=master)](https://snnu-sdk.readthedocs.io/zh_CN/dev/?badge=master)
7+
[![GitHub license](https://img.shields.io/github/license/ZhaoQi99/SNNU-SDK.svg)](https://github.com/ZhaoQi99/SNNU-SDK/blob/dev/LICENSE)
8+
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/snnucs/SNNU-SDK.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/snnucs/SNNU-SDK/context:python)
9+
10+
11+
# 陕西师范大学(SNNU) 第三方Python SDK
12+
---
13+
SNNU-SDK 是陕西师范大学(SNNU)的一个第三方Python-SDK，实现了校内常用服务如教务处、图书馆、校园卡、教室查询等接口的Python封装。
14+
15+
## 功能
16+
### Urp教务系统
17+
- 本学期课表
18+
- 历年课表
19+
- 本学期成绩
20+
- 历年考试成绩
21+
- 必修课绩点
22+
23+
### 图书馆
24+
- 基本信息
25+
- 在借书籍
26+
- 预约书籍
27+
- 现金事务
28+
- 挂失、解挂图书证
29+
- 预约到馆信息
30+
31+
### 教室
32+
- 某教学楼的所有教室号
33+
- 某教学楼某周的所有教室的状态
34+
- 某教学楼某周某一教室的状态
35+
36+
### 校园卡
37+
- 校园卡消费明细
38+
- 校园卡余额
39+
- 校园卡照片
40+
41+
### 通知新闻
42+
- 某部门的最新通知
43+
- 某部门的最新新闻
44+
- 所支持的部门
45+
46+
## 安装
47+
### 安装snnusdk
48+
```bash
49+
pip install snnusdk
50+
✨🍰✨
51+
52+
```
53+
### (可选)安装Tesseract-OCR
54+
如需正常使用Urp教务系统相关功能，需安装OCR识别引擎
55+
- [Windows](https://github.com/tesseract-ocr/tesseract/wiki#windows)
56+
- [Linux](https://github.com/tesseract-ocr/tesseract/wiki#linux)
57+
- [Mac OS](https://github.com/tesseract-ocr/tesseract/wiki#macos)
58+
## 使用示例
59+
这里是一些简单的使用案例
60+
```Python
61+
from snnusdk import Urp
62+
urp = Urp(account='B11111111', password='xxx')
63+
64+
>>> urp.getCourses()
65+
[
66+
{
67+
'id': '1241416',
68+
'name': '算法设计与分析',
69+
'number': '01',
70+
'credits': 3.0,
71+
'attributes': '必修',
72+
'teacher': '王小明*',
73+
'status': '置入',
74+
'info': [
75+
{
76+
'week': '1-18周上',
77+
'day': '2',
78+
'timeOfClass': '1',
79+
'numOfClass': '2',
80+
'campus': '长安校区',
81+
'buildings': '长安文津楼',
82+
'room': '1511'
83+
}
84+
]
85+
}
86+
]
87+
88+
from snnusdk import Libiary
89+
libiary = Library(username='B11111111', password='xxx')
90+
91+
>>> library.getInfo()
92+
{
93+
'帐号ID': '2016xxxxx',
94+
'姓名': '张三',
95+
'昵称': 'xx',
96+
'登录次数': '123',
97+
'状态': '正常'
98+
}
99+
```
100+
101+
## 文档
102+
你可以在[https://snnucs.github.io/SNNU-SDK](https://snnucs.github.io/SNNU-SDK)看到本项目的完整使用文档。
103+
104+
## 贡献你的代码
105+
欢迎您贡献出自己的一份力量，你可以随时提交`issue`或`fork`本仓库,静候你的`pull request`。
106+
107+
## 贡献者
108+
感谢所有对本项目做出过贡献的开发者([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
109+
110+
111+
| [<img src="https://avatars3.githubusercontent.com/u/40024866?v=4" width="100px;"/><br /><sub><b>jhy</b></sub>](https://Small-funny.github.io/)<br />[💻](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=Small-funny "Code") [📖](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=Small-funny "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/7782671?v=4" width="100px;"/><br /><sub><b>Keyi Xie</b></sub>](https://xiekeyi98.github.io/)<br /> [📖](https://github.com/ZhaoQi99/SNNU-SDK/commits?author=xiekeyi98 "Documentation") |
112+
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
113+
114+
## 谁在使用
115+
116+
## 开源协议 & 作者
117+
* 作者:Qi Zhao([zhaoqi99@outlook.com](mailto:zhaoqi99@outlook.com))
118+
* 开源协议:[GNU General Public License v3.0](https://github.com/ZhaoQi99/SNNU-SDK/blob/dev/LICENSE)

0 commit comments

Comments
 (0)