Skip to main content

나이스 API를 활용할 수 있게 도와주는 파이썬 패키지 입니다

Project description

Neis API

PyPI version PyPI downloads ./LICENSE

Neis_API는 나이스 교육정보 개방 포탈을 이용합니다.
자세한 정보는 나이스 교육정보 개방 포탈 를 참고해주세요.

특징

  • 나이스 API에 올라와있는 데이터를 가져오고, 활용할 수 있습니다.

설치

pip install Neis-API

예시

School

School 객체를 만들어서 여러정보를 빠르게 검색합니다.

from Neis_API import Region, School

school = School.find(region_code=Region.SEOUL,
                     school_code="7091432")

School.get_meal_info

급식을 검색합니다. 날짜를 입력받으면 아침, 점심, 저녁 급식을 return받습니다.

meal_data = school.get_meal_info(2021, 11, 9)
print(meal_data[0].dish_name)

출력

기장흑미밥
얼큰꽃게탕5.8.9.13.17.18.
감자채볶음1.5.10.13.
매콤닭불구이1.2.5.6.15.
배추김치9.13.
힘내파인애플씨13.

School.get_school_info

학교정보를 return받습니다.

school_data = school.get_school_info()
print(school_data.school_code)

출력

7091432

School.get_schedule_info

학사일정을 검색합니다 날짜를 입력받으면 그날 모든 학사일정을 return받습니다.

schedule_1207 = school.get_schedule_info(2021, 12, 7)
print(schedule_1207[0].event_info)

출력

기말고사(2)

mealInfo.mealInfo

from Neis_API import Region, mealInfo

data = mealInfo.get_meal_data(region_code=Region.SEOUL,
                              school_code="7091432",
                              date="20211109")
print(data[0].dish_name)

출력

기장흑미밥
얼큰꽃게탕5.8.9.13.17.18.
감자채볶음1.5.10.13.
매콤닭불구이1.2.5.6.15.
배추김치9.13.
힘내파인애플씨13.

schoolInfo.schoolInfo

from Neis_API import Region, schoolInfo

school_name = "서운중학교"
data = schoolInfo.get_school_data(region_code=Region.SEOUL,
                                  school_code=school_name)
print(data[0].school_code)

출력

7091432

schoolschedule.schoolInfo

from Neis_API import Region, schoolschedule


school_name = "서운중학교"
data = schoolschedule.get_schedule_data(region_code=Region.SEOUL,
                                        school_code=school_name,
                                        date="20211207")
print(data[0].event_name)

출력

기말고사(2)

시도교육청코드

Region

Region.SEOUL     (서울) : B10
Region.BUSAN     (부산) : C10
Region.DAEGU     (대구) : D10
Region.INCHEON   (인천) : E10
Region.GWANGJU   (광주) : F10
Region.DAEJEON   (대전) : G10
Region.ULSAN     (울산) : H10
Region.SEJONG    (세종) : I10
Region.GYEONGGI  (경기) : J10
Region.GANGWON   (강원) : K10
Region.CHUNGBUK  (전북) : M10
Region.CHUNGNAM  (전남) : N10
Region.JEONBUK   (전북) : P10
Region.JEONNAM   (전남) : Q10
Region.GYEONGBUK (경북) : R10
Region.GYEONGNAM (경남) : S10
Region.JEJU      (제주) : T10
Region.FORIENGER (그 외 국제학교) : V10

오류 (exceptions)

ERROR-300   : 필수 값이 누락되어 있습니다... -> 필수값을 다시 확인해주십시오.
ERROR-290   : 인증키가 유효하지 않습니다... -> KEY값 오류입니다.
ERROR-333   : 요청위치 값의 타입이 유효하지 않습니다... -> pindex 또는 isize의 값이 자연수로 설정해주세요.
ERROR-336   : 데이터요청은 한번에 최대 1,000건을 넘을 수 없습니다.
ERROR-337   : 일별 트래픽 제한을 넘은 호출입니다. 오늘은 더이상 호출할 수 없습니다.
ERROR-500   : 서버 오류입니다. 지속적으로 발생시 홈페이지로 문의(Q&A) 바랍니다.
ERROR-600   : 데이터베이스 연결 오류입니다. 지속적으로 발생시 홈페이지로 문의(Q&A) 바랍니다.
ERROR-601   : SQL 문장 오류 입니다. 지속적으로 발생시 홈페이지로 문의(Q&A) 바랍니다.


INFO-300    : 관리자에 의해 인증키 사용이 제한되었습니다.
INFO-200    : 해당하는 데이터가 없습니다.

라이선스

이 프로젝트는 MIT License에 속해 있습니다.

도와주신 분

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

Neis_API-0.6.0.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

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

Neis_API-0.6.0-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file Neis_API-0.6.0.tar.gz.

File metadata

  • Download URL: Neis_API-0.6.0.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for Neis_API-0.6.0.tar.gz
Algorithm Hash digest
SHA256 2f68143e9e1cb7595833a1b7bb75d3d93fa313627522718d0f97a2b77850d864
MD5 580fcfe05bfad71c465d0f66b488190e
BLAKE2b-256 7e9c394a19d9103dd0a2bdddeea71dd93c457e652bb95b086f279d72a91db1a0

See more details on using hashes here.

File details

Details for the file Neis_API-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: Neis_API-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for Neis_API-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 106dbccf11cc50a35999431cc1deab94e1665194c53d131e9a05cfc926320d99
MD5 08e8511283d29de597a68759b8a4fb46
BLAKE2b-256 319dbf7fc1ec8bef126dd5edf7c811ef0c3eea10611f026ded7fc7808666d3a6

See more details on using hashes here.

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