ct-schools

Get data about Connecticut schools


License
GPL-3.0
Install
pip install ct-schools==0.0.6

Documentation

CT_SCHOOLS

    A python library for getting profile data on ct schools from fuzzy
    school names

    Data comes from here:
    https://data.ct.gov/Education/CT-Public-Schools/3z9z-e275

    And removes separates out the lat/lng from the school address field.

    Fuzziness comes from fuzzywuzzy: https://github.com/seatgeek/fuzzywuzzy

WHY?

    I have a lot of spreadsheets with school names spelled almost the same
    way. This helps a lot.
    

INSTALL

    pip install ct_schools 

FUNCTIONS

    All functions below return a DataFrame or None. See demo/*.py to see
    them in action, or read through tests/test_api.py.

    * schools.closest(SCHOOL_NAME_STRING, lim=n) - return the closest n
      matches (defaults to 1 match) for the given school name.

    * schools.exact(SCHOOL_NAME_STRING) - return schools with the exact
      (case-insensitive) school anep

    * schools.contains(SCHOOL_NAME_STRING) - return schools whose name
      contains the given string

    * schools.fuzz(SCHOOL_NAME, ratio=75) - return schools with names above
      the given fuzzywuzzy ratio (defaults to 75)

    * schools.dictify(dataframe) - convert the dataframe to a
      record-oriented list of dicts

    * schools.jasonify(dataframe) - convert the dataframe to
      record-oriented json string

TESTS

    To run tests use:

       	   py.test tests/

    from root directory of this repo.
    Requires pytest, pandas