-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
775 additions
and
298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,58 @@ | ||
# Ask Schools | ||
|
||
[ | ||
![PyPI](https://img.shields.io/pypi/v/ask_schools.svg) | ||
![PyPI](https://img.shields.io/pypi/pyversions/ask_schools.svg) | ||
![PyPI](https://img.shields.io/github/license/guinslym/ask_schools.svg) | ||
](https://pypi.org/project/ask_schools/) | ||
[![TravisCI](https://travis-ci.org/guinslym/ask_schools.svg?branch=master)](https://travis-ci.org/guinslym/ask_schools) | ||
|
||
|
||
This package helps convert Ask School suffixes to the school full name. | ||
# SP Ask School | ||
|
||
A Python package for managing school information and queues for Scholars Portal Ask service. This package provides utilities to manage and query information about various Ontario universities and their associated chat queues. | ||
|
||
## Installation | ||
|
||
**Ask Schools** can be installed from PyPI using `pip` or your package manager of choice: | ||
You can install the package via pip: | ||
|
||
``` | ||
pip install ask_schools | ||
```bash | ||
pip install sp-ask-school | ||
``` | ||
|
||
## Usage | ||
|
||
```python | ||
from sp_ask_school import ( | ||
find_school_by_operator_suffix, | ||
find_queues_from_a_school_name, | ||
find_school_by_queue_or_profile_name | ||
) | ||
|
||
# Find school from operator suffix | ||
school = find_school_by_operator_suffix("operator_tor") | ||
print(school) # Output: "toronto" | ||
|
||
# Get queues for a school | ||
queues = find_queues_from_a_school_name("Toronto") | ||
print(queues) # Output: ["toronto", "toronto-mississauga", ...] | ||
|
||
# Find school from queue name | ||
school = find_school_by_queue_or_profile_name("western-proactive") | ||
print(school) # Output: "Western" | ||
``` | ||
|
||
## Features | ||
|
||
Example: | ||
- Find school information by operator suffix | ||
- Get queue lists for specific schools | ||
- Find school information by queue name | ||
- Support for French and SMS queues | ||
- Practice queue management | ||
- Support for multiple university profiles | ||
|
||
```python | ||
## Contributing | ||
|
||
from ask_schools import find_school_by_operator_suffix | ||
Contributions are welcome! Please feel free to submit a Pull Request. | ||
|
||
def test_check_school_name_equal_toronto(): | ||
result = find_school_by_operator_suffix('_tor') | ||
assert result == 'Tordonto' | ||
``` | ||
## License | ||
|
||
This project is licensed under the MIT License - see the LICENSE file for details. | ||
|
||
## Authors | ||
|
||
- Guinsly Mondésir | ||
|
||
## Code of Conduct | ||
## Maintained by | ||
|
||
Everyone interacting in the project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/). | ||
[Scholars Portal](https://scholarsportal.info/) |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.