highlight examples of things in the repo that work

Police-Data-Accessibility-Project / scrapers

Code relating to scraping public police data.

https://pdap.io

GNU General Public License v3.0

157 stars 33 forks source link

highlight examples of things in the repo that work #212

Closed josh-chamberlain closed 10 months ago

josh-chamberlain commented 10 months ago

[x] We tell people how to test in general in the readme, but let's give them a working example or two. This helps people who are new to scraping understand the point.
- describe the strategy of the scraper ("This collects type of record from department by how it works.")
- make sure its readme works
[x] readme: what are utilities, and why might you use them?
[x] readme: what are data portal scrapers, and why might you use them?

josh-chamberlain commented 10 months ago

@EvilDrPurple now that you're our resident scrapers repo expert, do you have thoughts on an example scraper which could work here? Other than this, all the tasks in #197 are mine.

EvilDrPurple commented 10 months ago

@josh-chamberlain Well, in my most humble opinion I believe the scraper I worked on 15 months ago for Pittsburgh data is a good example. It utilized both a data portal scraper and a file downloader util in one file. It appears to still work Link Other than that, just taking a quick look the Chico, CA college scraper looks like a good example of using the crimegraphics data portal, though the README could use some work as it is just the default template README Link The Atlanta, GA scrapers seem to be a decent example of using the list_pdf utils Link

Let me know what you think!

josh-chamberlain commented 10 months ago

@EvilDrPurple perfect! Thank you for helping us welcome people to the project