| Name | umd-api JSON |
| Version |
0.65.6
JSON |
| download |
| home_page | None |
| Summary | A package for accessing the UMD API in Python |
| upload_time | 2025-02-21 09:59:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
umd
education
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UMD API
## UMD API Docs (`umd_api/general`)
[https://beta.umd.io/](https://beta.umd.io/)
## PlanetTerp (`umd_api/planet_terp`)
[https://planetterp.com/api/](https://planetterp.com/api/)
## PyPI
[https://pypi.org/project/umd-api](https://pypi.org/project/umd-api)
## Installation
```bash
pip install umd-api
```
## Initialization
```python
from umd_api.general import Bus, Courses, Majors, Map, Professors
bus = Bus()
courses = Courses()
majors = Majors()
map_ = Map()
professors = Professors()
```
```python
from umd_api.planet_terp import Search, Grades, Professors, Courses
search = Search()
grades = Grades()
professors = Professors()
courses = Courses()
```
```python
from umd_api.weather import Weather, Forecast
weather = Weather()
forecast = Forecast()
```
## Methods
<details>
<summary><strong>General</strong></summary>
**Bus**
- `list_routes()`
- `view_specific_routes(route_ids)`
- `list_stops()`
- `get_specific_stops(stop_ids : list)`
- `current_bus_locations_by_route(route_id)` **(UMD.IO API IS BROKEN HERE)**
- `bus_schedules(route_id)`
- `get_arrivals_for_stop(route_id, stop_id)`
---
**Courses**
- `list_courses(sort=None, page=None, per_page=None, semester=None, credits=None, dept_id=None, gen_ed=None)`
- `list_minified_courses(sort=None, page=None, per_page=None, semester=None)`
- `list_sections(sort=None, page=None, per_page=None, course_id=None, seats=None, open_seats=None, waitlist=None, semester=None)`
- `view_specific_sections(section_ids : list)`
- `view_specific_courses(course_ids : list, semester=None)`
- `view_sections_for_course(course_ids : list, semester=None)`
- `view_specific_sections_for_course(course_ids : list, section_ids : list)`
- `list_semesters()`
- `list_departments()`
---
**Majors**
- `list_majors()`
---
**Map**
- `list_buildings()`
- `get_buildings(building_id : list)`
---
**Professors**
- `get_professor(name: str, reviews=False)`
- `get_all_professors(type=None, reviews=False, limit=100, offset=0)`
</details>
<details>
<summary><strong>PlanetTerp</strong></summary>
**Search**
- `search(query, limit=30, offset=0)`
---
**Grades**
- `get_grades(course=None, professor=None, semester=None, section=None)`
---
**Professors**
- `get_professor(name: str, reviews=False)`
- `get_all_professors(type=None, reviews=False, limit=100, offset=0)`
---
**Courses**
- `get_course(name, reviews=False)`
- `get_courses(department=None, reviews=False, limit=100, offset=0)`
</details>
<details>
<summary><strong>Weather</strong></summary>
**Weather**
- `get_weather_data(station="", start_time="", end_time=")`
- `get_hourly_forecast()`
- `save_radar_gif()`
- `get_weather_descrption()`
---
**Forecast**
- `get_hourly_forecast()`
- `get_weekly_forecast()`
</details>
### Wakatime (Time Spent Programming)
[](https://wakatime.com/badge/user/d2cf396a-1b98-4795-9559-b880684c63b7/project/6064c94d-4e62-413f-8e6f-68c974df4e07)
[](https://wakatime.com/badge/user/d2cf396a-1b98-4795-9559-b880684c63b7/project/8dd367da-8a21-4a43-9308-b02267536c0f)
Combine the two for total time
Raw data
{
"_id": null,
"home_page": null,
"name": "umd-api",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "umd, education, API",
"author": null,
"author_email": "Eshan Iyer <eshaniyer@duck.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/82/b1a2895228eb9d3eaab5dca4abd5481dc7b0ff4a96c72ef94a2d6d7c89de/umd_api-0.65.6.tar.gz",
"platform": null,
"description": "# UMD API\n\n## UMD API Docs (`umd_api/general`)\n[https://beta.umd.io/](https://beta.umd.io/)\n\n## PlanetTerp (`umd_api/planet_terp`)\n[https://planetterp.com/api/](https://planetterp.com/api/)\n\n## PyPI\n[https://pypi.org/project/umd-api](https://pypi.org/project/umd-api)\n\n## Installation\n```bash\npip install umd-api\n```\n\n## Initialization\n\n```python\nfrom umd_api.general import Bus, Courses, Majors, Map, Professors \n\nbus = Bus()\ncourses = Courses()\nmajors = Majors()\nmap_ = Map()\nprofessors = Professors()\n```\n\n```python\nfrom umd_api.planet_terp import Search, Grades, Professors, Courses\n\nsearch = Search()\ngrades = Grades()\nprofessors = Professors()\ncourses = Courses()\n```\n\n```python\nfrom umd_api.weather import Weather, Forecast\n\nweather = Weather()\nforecast = Forecast()\n```\n\n## Methods\n\n<details>\n<summary><strong>General</strong></summary>\n\n**Bus**\n- `list_routes()`\n- `view_specific_routes(route_ids)`\n- `list_stops()`\n- `get_specific_stops(stop_ids : list)`\n- `current_bus_locations_by_route(route_id)` **(UMD.IO API IS BROKEN HERE)**\n- `bus_schedules(route_id)`\n- `get_arrivals_for_stop(route_id, stop_id)`\n\n---\n\n**Courses**\n- `list_courses(sort=None, page=None, per_page=None, semester=None, credits=None, dept_id=None, gen_ed=None)`\n- `list_minified_courses(sort=None, page=None, per_page=None, semester=None)`\n- `list_sections(sort=None, page=None, per_page=None, course_id=None, seats=None, open_seats=None, waitlist=None, semester=None)`\n- `view_specific_sections(section_ids : list)`\n- `view_specific_courses(course_ids : list, semester=None)`\n- `view_sections_for_course(course_ids : list, semester=None)`\n- `view_specific_sections_for_course(course_ids : list, section_ids : list)`\n- `list_semesters()`\n- `list_departments()`\n\n---\n\n**Majors**\n- `list_majors()`\n\n---\n\n**Map**\n- `list_buildings()`\n- `get_buildings(building_id : list)`\n\n---\n\n**Professors**\n- `get_professor(name: str, reviews=False)`\n- `get_all_professors(type=None, reviews=False, limit=100, offset=0)`\n</details>\n\n<details>\n<summary><strong>PlanetTerp</strong></summary>\n\n**Search**\n- `search(query, limit=30, offset=0)`\n\n---\n\n**Grades**\n- `get_grades(course=None, professor=None, semester=None, section=None)`\n\n---\n\n**Professors**\n- `get_professor(name: str, reviews=False)`\n- `get_all_professors(type=None, reviews=False, limit=100, offset=0)`\n\n---\n\n**Courses**\n- `get_course(name, reviews=False)`\n- `get_courses(department=None, reviews=False, limit=100, offset=0)`\n</details>\n<details>\n<summary><strong>Weather</strong></summary>\n\n**Weather**\n- `get_weather_data(station=\"\", start_time=\"\", end_time=\")`\n- `get_hourly_forecast()`\n- `save_radar_gif()`\n- `get_weather_descrption()`\n---\n\n**Forecast**\n- `get_hourly_forecast()`\n- `get_weekly_forecast()`\n\n</details>\n\n\n### Wakatime (Time Spent Programming)\n\n[](https://wakatime.com/badge/user/d2cf396a-1b98-4795-9559-b880684c63b7/project/6064c94d-4e62-413f-8e6f-68c974df4e07)\n\n[](https://wakatime.com/badge/user/d2cf396a-1b98-4795-9559-b880684c63b7/project/8dd367da-8a21-4a43-9308-b02267536c0f)\n\nCombine the two for total time\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package for accessing the UMD API in Python",
"version": "0.65.6",
"project_urls": {
"Documentation": "https://github.com/Nazchanel/umd-api-python/blob/master/README.md",
"Source": "https://github.com/Nazchanel/umd-api-python"
},
"split_keywords": [
"umd",
" education",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fc27c98c24de540f4b7674e68a7b667d0439b59a8f5aa86fa0d945275387589a",
"md5": "fe15cd9394e6eb3ab623e221cb24c413",
"sha256": "4ad78d73f0d06f59192cc7184a837a7f3b1061c39981f48e04ce50cd187bc2bb"
},
"downloads": -1,
"filename": "umd_api-0.65.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe15cd9394e6eb3ab623e221cb24c413",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 13228,
"upload_time": "2025-02-21T09:59:17",
"upload_time_iso_8601": "2025-02-21T09:59:17.063550Z",
"url": "https://files.pythonhosted.org/packages/fc/27/c98c24de540f4b7674e68a7b667d0439b59a8f5aa86fa0d945275387589a/umd_api-0.65.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2b82b1a2895228eb9d3eaab5dca4abd5481dc7b0ff4a96c72ef94a2d6d7c89de",
"md5": "40392b88a780b419d61522047333d3c6",
"sha256": "7a1f2da9bc39513caefa925fe7d8b0b9d0663649e74a1645d69afea3e9b2d83e"
},
"downloads": -1,
"filename": "umd_api-0.65.6.tar.gz",
"has_sig": false,
"md5_digest": "40392b88a780b419d61522047333d3c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10188,
"upload_time": "2025-02-21T09:59:18",
"upload_time_iso_8601": "2025-02-21T09:59:18.184844Z",
"url": "https://files.pythonhosted.org/packages/2b/82/b1a2895228eb9d3eaab5dca4abd5481dc7b0ff4a96c72ef94a2d6d7c89de/umd_api-0.65.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-21 09:59:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Nazchanel",
"github_project": "umd-api-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "umd-api"
}
