Skip to main content

Unofficial Comcigan API python wrapper

Project description

comcigan-py

GitHub Workflow Status PyPI - Python Version PyPI PyPI - Downloads Codecov

English | 한국어

Comcigan-py is a parser for korean school timetable service "comcigan" made with python.

Installation

Install and update using pip:

$ pip install comcigan

Example

A simple example for sync/async version

from comcigan import School, AsyncSchool

myschool = School("schoolname")
myschool = await AsyncSchool.init("schoolname")  # or this for async version
# "schoolname" doesn't have to be the full name of the school.
# comcigan-py automatically recognizes "schoolname" as a search query.
# If there is only one school searched, an instance of that school is created.
# If there are more than two schools searched, ValueError is raised.
# If there is no school searched, NameError is raised.

print(myschool.name)  # This prints the school's name
# The result may not be the same as "schoolname".

print(myschool[2][3][3][3])
# This returns Thursday 3rd period in the 2nd grade 3rd class.

License

This project is under the GNU Lesser General Public License version 3.0 or later (LGPL v3.0+).

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

comcigan-1.4.9.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

comcigan-1.4.9-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

Details for the file comcigan-1.4.9.tar.gz.

File metadata

  • Download URL: comcigan-1.4.9.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for comcigan-1.4.9.tar.gz
Algorithm Hash digest
SHA256 68273bd10402cd2d70553c0d9cb20f4eb17361d0750771eed7a57a8ac71db063
MD5 5caed890e00c5f3f4a300063923208c6
BLAKE2b-256 a2c8ace6fc0719b948f5ec45144ccf7ef0ebc749ae36a091a2fa73be1c56ce56

See more details on using hashes here.

File details

Details for the file comcigan-1.4.9-py3-none-any.whl.

File metadata

  • Download URL: comcigan-1.4.9-py3-none-any.whl
  • Upload date:
  • Size: 9.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for comcigan-1.4.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c5b0b86abbbea4cc29d63656f11848efaaf8bb46c4ab9567f0d22270abd63c86
MD5 ec51ad86c671f133ad1d5039af81ee2c
BLAKE2b-256 f5c3c9f24fd17cb016b39aea876b863c0a40e2eb3d6bd3b179477d4f8c2d4a83

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page