Metadata-Version: 2.1
Name: uni-rank
Version: 1.0.0
Summary: Get the ordered list of USA universities based on their latest ranking.
Home-page: https://github.com/nahid18/uni-rank
Author: Abdullah Al Nahid
Author-email: nahidpatwary1@gmail.com
License: GPLv3
Project-URL: Documentation, https://github.com/nahid18/uni-rank/blob/main/README.md
Description: # Uni-rank
        
        [![Build Status](https://www.travis-ci.com/nahid18/uni-rank.svg?branch=main)](https://www.travis-ci.com/nahid18/uni-rank)
        
        Uni-rank is a mini python package to get the ordered list of USA universities based on their latest ranking on [usnews.com/best-colleges](https://usnews.com/best-colleges)
        
        This package also provides few other information like state, city, zip code and the result can be stored as a `csv` or `json` file.
        
        Installation
        ----
        
        Uni-rank requires Python 3 to run. 
        
        Install the package by running:
        ```sh
        pip install uni-rank
        ```
        
        Usage
        ----
        ```sh
        # import
        from unirank import Ranking
        
        # instantiate
        rank = Ranking()
        
        # get the ordered list of USA universities
        usa = rank.get_usa()
        print(usa)
        
        
        ### Helper Functions ###
        
        # 1. Print University Names
        rank.print_names()
        
        # 2. Select Universities by States
        # Input: State List, Output: DataFrame of filtered universities
        states = ['NJ', 'MA']
        state_result = rank.select_by_state(states)
        
        # 3. Select Universities by Cities
        # Input: City List, Output: DataFrame of filtered universities
        cities = ['Cambridge']
        city_result = rank.select_by_city(cities)
        
        # You can also get the ordered list by the properties
        names = [uni["displayName"] for uni in usa]
        print(names)
        
        
        ### Export ###
        
        # Export as CSV
        rank.save_csv(usa, "usa_list.csv")
        
        # Export as json
        rank.save_json(usa, "usa_list.json")
        ```
        
        
        USA University Properties:
        ----
        key | detail
        --- | ---
        `displayName` | Name
        ``rankingDisplayRank`` | Rank
        `state` | State
        `city` | City
        `zip` | Zip Code
        `description` | Description
        
        
        Note
        ----
        Intend to extend the package to support other types of rankings and also include other countries on later versions, hence the name `uni-rank` not `usa-rank`
        
        License
        ----
        
        GNU General Public License
        
        ## History
        
        ### 1.0 (14-01-2020)
        * First release on PyPI
Keywords: ranking usa university
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
