open-neis-api wrapping with aiohttp
Project description
neispy
현재 급식, 학교 정보, 학사 일정만 가져올수있습니다.
Discord.py와 충돌이 발생하지 않게 aiohttp로 래핑하였습니다.
api키는 이곳에서 받으실 수 있습니다.
설치 방법
pip install neispy
업데이트 방법
pip install --upgrade neispy
사용 예시
import neispy
import asyncio
name = "인천석천초등학교"
async def main():
#필수인자가 들어가는곳입니다. API키,json,xml등 받을방식등등..
#아무값이 없으니 샘플키로 요청합니다.
neis = neispy.Client()
#학교이름으로 학교정보를 요청하고 교육청코드 와 학교코드로 가져옵니다.
schoolinfo = await neis.schoolInfo(SCHUL_NM=name)
scinfo = neispy.NeispySchoolInfo(schoolinfo)# 모델부분입니다 이클래스를 이용하여 밑에 변수와같이 쉽게 가져올수있습니다.
AE = scinfo.ATPT_OFCDC_SC_CODE#교육청코드
SE = scinfo.SD_SCHUL_CODE#학교코드
#20190122날의 급식정보를 요청하고 급식 항목만 가져옵니다.
scmeal = await neis.mealServiceDietInfo(AE, SE, MLSV_YMD=20190122)
mealinfo = neispy.NeispyMealServiceDietInfo(scmeal)
meal = mealinfo.meal()#급식항목만 줄바꿈으로 변환하여 가져옵니다.
#20190307날의 학사일정을 요청하고 학사일정의 이름을 가져옵니다.
scschedule = await neis.SchoolSchedule(AE, SE, AA_YMD=20190307)
schinfo = neispy.NeispySchoolSchedule(scschedule)
schedule_name = schinfo.EVENT_NM
#학교코드로 20200122날의 시간표을 요청하고 반환값을 정리하여 시간표만 가져옵니다.
#초등학교는 els
#중학교는 mis
#고등학교는 his 를 넣어주시면됩니다.
sctimetable = await neis.timeTable('els', AE, SE, 2019, 2, 20200122, 1, 1)
timetableinfo = neispy.NeispyTimeTable(sctimetable, 'elsTimetable')#초,중,고학교를 정해주셔야합니다.
timetable = timetableinfo.timetable()#시간표만 리스트로 반환합니다.
print(AE)
print(SE)
print(meal)
print(schedule_name)
print(timetable)
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
#출력값
#E10
#7341038
#보리밥
#사과
#비엔나소시지케첩조림2.5.6.10.12.13.
#궁중떡볶이1.5.6.13.
#알타리김치9.13.
#청국장찌개(신)5.9.13.
#학급임원선거
#['즐거운생활', '수학', '국어', '즐거운생활']
인자값
변수명 | 타입 | 변수 설명 | 설명 |
---|---|---|---|
KEY | STRING(필수) | 인증키 | 기본값 : sample key |
Type | STRING(필수) | 호출 문서(xml, json) | 기본값 : json |
pIndex | INTEGER(필수) | 페이지 위치 | 기본값 : 1(sample key는 1 고정) |
pSize | INTEGER(필수) | 페이지 당 신청 숫자 | 기본값 : 100(sample key는 5 고정) |
시간표 같은 부분은 초,중,고인걸 제외하고는 모두 같으니 출력 항목만 보시면됩니다.
Patch note
0.5.0
-
Model 메커니즘 변경
-
docstring 추가
0.4.0
- 초,중,고 시간표엔드포인트 커버가능
0.3.4
- Model 메커니즘 변경
0.3.3
- Model클래스에서 sort_meal함수의 이름이달라 생긴문제 수정
0.3.2
- 코드 퀄리티 향상
0.3.1
- 코드 퀄리티 향상
0.3.0
- 코드 다시 쓰기 분기 합병
- 학원교습소 정보 추가
- 예외처리 추가
- 코드 최적화
0.2.3
- 초등학생 시간표 추가
0.2.2
- Issue #1 버그수정
- 샘플키로 요청하도록 변경
0.2.1
- 학사일정 추가
0.2.0
- 학교정보,급식일정 모든 인자값 받을수있음.
0.1.1
- 사용하지 않는 모듈 제거,사용하기쉽도록 함수이름 변경
0.1.0
- 첫 배포 시작
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
neispy-0.5.0.tar.gz
(10.3 kB
view hashes)
Built Distribution
neispy-0.5.0-py3-none-any.whl
(9.7 kB
view hashes)