Skip to content

Commit

Permalink
markdown cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
bmos committed Apr 22, 2024
1 parent be3b44b commit 67360f3
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,18 @@

# Long Term Rental License Downloader for Portland, ME

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.
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.

## Data Downloaded

As written, the script downloads a list of all Long-Term Rental licenses issued since Jan 1 2022. It then looks up the details of each one, saving them as JSON data in the final column of the dataframe.
As written, the script downloads a list of all Long-Term Rental licenses issued since Jan 1 2022. It then looks up the details of each one, saving them as JSON
data in the final column of the dataframe.

## Prerequisites

To run this code, you'll need to have Python 3.9, 3.10, 3.11, or 3.12 installed on your machine. You'll also need to install the required packages by running the following command from inside the project folder:
To run this code, you'll need to have Python 3.9, 3.10, 3.11, or 3.12 installed on your machine. You'll also need to install the required packages by running
the following command from inside the project folder:

```shell
python3 -m pip install .
Expand All @@ -24,12 +27,14 @@ python3 -m pip install .
2. Open a terminal and run the following command to create a CSV of licenses:

```shell
python3 -m license_downloader
python3 -m src.license_downloader
```

## Notes

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.
- `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

0 comments on commit 67360f3

Please sign in to comment.