update readme

This commit is contained in:
2026-01-20 19:07:41 -08:00
parent 56c1ba7676
commit 01a4de1436

View File

@ -11,7 +11,6 @@ Relevant but not 1-1 walkthrough of how to programmatically find building owners
## Project Structure
- `processors/`: directory for Python scripts to extract, transform, and load the data
- `postgis-data/`: directory that will hold the PostgreSQL data
- `data/`: currently ignored by git, need to share manually
- `inputs/`: directory with only files that come directly from APIs or public websites
- `intermediates/`: directory for folders containing intermediate transformed versions of the inputs
@ -27,6 +26,7 @@ TODO: Find a good source for eviction filing data. Those with access can refer t
## Object Storage
### King County Assessor Data
An S3 compatible storage is hosted on [minio.radmin.live](minio.radmin.live)
SDK documentation: https://github.com/minio/minio-py/blob/master/docs/API.md
@ -36,3 +36,6 @@ Use `lib/minio_helper.py` to extend the functionality
Run `test_minio` in `lib/main.py` to test out that it works (TODO: move this to own testing script, perhaps unit tests)
Note: You will need to have minio_access_key and minio_secret_key in your env before running for this to work, contact @linnealovespie or @ammaratef45 to obtain these keys)
### CCFS Data
We have our own copy of the [CCFS database](https://kingcounty.gov/en/dept/kcit/data-information-services/gis-center/property-research). Contact @linnealovespie or @jessib to get the `.env` file needed to load in the connection string secrets.