Metadata-Version: 2.1
Name: vt-timetable
Version: 0.2.3
Summary: A python module for scraping the Virginia Tech Timetable of Classes.
Home-page: https://github.com/dipernalz/vt-timetable
Author: Leo DiPerna
Author-email: dipernalz@vt.edu
License: UNKNOWN
Project-URL: Documentation, https://leodiperna.com/projects/vt-timetable/documentation
Project-URL: Issues, https://github.com/dipernalz/vt-timetable/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
License-File: LICENSE

# vt-timetable

A python module for scraping the Virginia Tech Timetable of Classes.

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. Additionally, `get_crn` makes it easier to search for a specific
course. The two other functions, `get_semesters` and `get_subjects`, make it
possible to check which search parameters are valid.

Documentation can be found
[here](https://leodiperna.com/projects/vt-timetable/documentation).

## Getting started

This module can be installed from the Python Package Index.

```console
pip install vt-timetable
```

After installing the module, it can be imported with:

```python
import vtt
```

## Examples

Getting data about CRN 83075 for Fall 2021, and checking if there are any open
spots:

```python
course = get_crn('2021', Semester.FALL, '83075')
course.has_open_spots()
```

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',
                 modality=Modality.IN_PERSON)
```

