Improving CourseAPI - Githubissues

pittcsc / PittAPI

An API to easily get data from the University of Pittsburgh

https://pittapi.pittcsc.org

GNU General Public License v2.0

105 stars 30 forks source link

Improving CourseAPI #43

Closed azharichenko closed 7 years ago

azharichenko commented 7 years ago

General Improvements to Achieve

[x] Better and more stable API Code
[x] More Documentation
[x] More Unit tests

API Issues/Improvements from #22

[x] Performing different queries based on which subject code is used
[x] Checking whether the subject is valid
- Returning ValueError when invalid
[x] Checking whether the term entered is valid
[x] Returning empty list when no courses are offered
[x] Adding full list of subject codes into API

API Improvements

[x] Cleaning up the extraction of course data
- Issue with some courses going index out of bounds

Documentation Improvements

[x] Proper docstrings followiwng PEP 257
[x] Example code and sample output in docstrings and DOCS.md

Unit tests

[x] Test all different ways of querying
[x] Testing API fails safely with exceptions
- [x] Test fake subjects
- [x] Test fake terms
[x] Test private functions