Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bmos authored Oct 16, 2023
1 parent 5ffbe36 commit 125fab8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![Pylint](https://github.com/MaineDSA/PortlandLTRData/actions/workflows/pylint.yml/badge.svg?branch=main)](https://github.com/MaineDSA/PortlandLTRData/actions/workflows/pylint.yml)

# Landlord License Data Downloader

This Python program allows you to download data about landlord licenses from the City of Portland website. It uses the `requests` library to send HTTP requests to the website's API and the `pandas` library to organize the data. It saves the results to a csv file.
Expand Down Expand Up @@ -28,4 +30,4 @@ The code contains two variables for easy testing and adjustment for usecase:

- `TESTMODE`: Set this to `True` if you want to test the program with small number of licenses (1 page of 20 licenses -- only iterating through Multi Family licenses). Set it to `False` if you want to download all Long Term Rental licenses.

- `PAGESIZE`: Set this to the desired number of licenses per page
- `PAGESIZE`: Set this to the desired number of licenses per page

0 comments on commit 125fab8

Please sign in to comment.