Search a large university database for basic information.
Project description
Python package to search for basic university information. This packages obtains information from Hipo/university-domains-list’s database. It is fully compatible with Python 2.6 and up.
Installation
Your preference should be to use PyPi: pip install universities
Source and wheel distributions are available in the releases tab as well.
Usage
import universities
uni = universities.API() # can specify encoding for use in Python 2
canadian = uni.search(country = "Canada") # or .search(country_code = "CA")
all_data = uni.get_all()
waterloo = uni.lucky(name = "Waterloo") # As in "I'm feeling lucky"
Available Functions
universities.search searches the entire database for universities matching the specified critera. You may filter by name, country_code or country as arguments to search. This returns a list of universities.models.University objects.
universities.lucky is an alias for search which only returns the first result of the search. All the same parameters are available, and a single universities.models.University is returned.
universities.get_all returns all of the entries in the database, in the same format as search. In fact, this is simply an alias for search that uses no arguments.
Any query which reurns multiple objects will return a Generator.
Models
universities.models.University is the basic model returned in all requests. It contains six fields:
name: The name of the university.
domains: A list of domain names the university uses (for emails, etc).
web_pages: A list of web pages associated with the university.
country_code: The two-letter ISO-3166 country code where the university is located.
stateprov: The state or province the university is located. This is usually not populated.
country: The full country name where the university is located.
Requirements
The only requirement is requests.
Development
Clone/fork the git repository.
cd to the directory and install the requirements if necessary: pip install -r requirements.txt
Edit to your heart’s content!
If you wish to contribute, push your changes to GitHub on your own fork and make a pull request.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for universities-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0959332749f8373c0d3f79e4208041fa17270a68e0c6dfe6bcd74013db5bd032 |
|
MD5 | 6442695a4395bb3b7fe4fe7c428d7b49 |
|
BLAKE2b-256 | cf6b98b98d73c9edc765f1562071cd0f40a5154839b562ba311cd532ea90b51e |