diff --git a/README.md b/README.md index 1ccab9a..09e618b 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ This module makes it easy to get data from the Virginia Tech Timetable of Classes using python. The most important components of the module are the `search_timetable` function, which directly searches the timetable with the provided parameters, and the `Course` class, which contains data about a -course. `search_timetable` returns a list of Course classes. Additionally, -`get_crn` makes it easier to search for a specific course and `get_subjects` -makes it easy to get a list of all the course subjects in the timetable. +course. Additionally, `get_crn` makes it easier to search for a specific course +and `get_subjects` makes it easy to get a list of all the course subjects in +the timetable. [Documentation can be found here.](https://leodiperna.com/projects/vt-timetable/documentation) @@ -28,7 +28,7 @@ import vtt ## Usage -This module comes with several Enumeration classes that are used as search +This module comes with several `Enum` classes that are used as search parameters for `search_timetable` and/or are returned by the getter functions in `Course`. More information about the getter functions can be found in the [documentation](https://leodiperna.com/projects/vt-timetable/documentation). @@ -45,10 +45,12 @@ Getting data about CRN 83075 for Fall 2021, and checking if there are any open spots: ```python -get_crn('2021', Semester.FALL, '83075').has_open_spots() +course = get_crn('2021', Semester.FALL, '83075') +course.get_open_spots() ``` -Getting a list of all MATH 2114 for Fall 2021 that are taking place in person: +Getting a list of all MATH 2114 sections for Fall 2021 that are taking place in +person: ```python search_timetable('2021', Semester.FALL, subject='MATH', code='2114', diff --git a/setup.cfg b/setup.cfg index e749681..cfee18d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,14 +1,12 @@ [metadata] name = vt-timetable -version = 0.1.0.dev1 +version = 0.1.0 author = Leo DiPerna author_email = dipernalz@vt.edu description = A module for scraping the Virginia Tech Timetable of Classes. long_description = file: README.md long_description_content_type = text/markdown url = https://github.com/dipernalz/vt-timetable -project_urls = - Source = https://github.com/dipernalz/vt-timetable classifiers = Programming Language :: Python :: 3 License :: OSI Approved :: MIT License diff --git a/src/vtt/__init__.py b/src/vtt/__init__.py index 52ebc14..4ddf0bb 100644 --- a/src/vtt/__init__.py +++ b/src/vtt/__init__.py @@ -4,9 +4,9 @@ Classes using python. The most important components of the module are the `search_timetable` function, which directly searches the timetable with the provided parameters, and the `Course` class, which contains data about a -course. `search_timetable` returns a list of Course classes. Additionally, -`get_crn` makes it easier to search for a specific course and `get_subjects` -makes it easy to get a list of all the course subjects in the timetable. +course. Additionally, `get_crn` makes it easier to search for a specific course +and `get_subjects` makes it easy to get a list of all the course subjects in +the timetable. """ from enum import Enum