joshuavictorchen / isp-checker Goto Github PK

This is a new project. Performance not guaranteed. Documentation can be found here.

Internet Service Provider (ISP) serviceability data are not readily available for listings on real estate websites such as Zillow and Trulia.

This means that homebuyers must manually navigate through the web interface for each potential ISP, one at a time, in order to assess the internet connectivity options for a given listing.

The isp-checker program provides a framework for retrieving ISP serviceability data across providers at any address - without having to trudge through each ISP website's clunky UI - by directly accessing specific API endpoints to retrieve this data.

The following ISPs and metadata are currently supported:

* virtually all Spectrum connections have options for 200+ Mbps plans

** all Verizon LTE Home Internet plans have stated download speeds of 25-50 Mbps

Prerequisites:

• Python 3.8+
• Git 2.33+

Navigate into a directory of choice and grab the code from this repository:

git clone https://github.com/joshuavictorchen/isp-checker.git isp-checker

cd into isp-checker and install the application. Use of a venv is recommended:

cd isp-checker
pip install -U -e .

Once installed, the ispcheck command can be executed from any working directory to check for ISP availability at a given address, or for a given Zillow or Trulia listing.

The program is in its early stages, and is not very robust. The command MUST be entered in one of the following forms, with no deviation. Two-liner addresses are not yet supported for manual address entry:

ispcheck [street address], [city name], [state abbreviation], [5 digit zip code]
- or -
ispcheck [URL for Zillow listing]
- or -
ispcheck [URL for Trulia listing]

For example:

ispcheck 123 neutronland road, reactorville, nc 12345

Refer to the documentation for more details.