Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more detailed docs for writing Scrapers #85

Open
6 tasks
zstumgoren opened this issue Dec 29, 2020 · 0 comments
Open
6 tasks

Add more detailed docs for writing Scrapers #85

zstumgoren opened this issue Dec 29, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@zstumgoren
Copy link
Member

Some bits that deserve extra documentation for potential contributors:

  • Sub-class the base Site class
  • Update the CLI framework to dynamically look up the correct Site class based on URL
  • Cache HTML and other intermediate file artifacts
  • Add tests using pytest and pytest-vcr
  • Write a Parser and pass to Site subclass to enable decoupling of fetching from data extraction steps
  • Mention Cache class and usage (i.e. make sure to cache html from scraped site)
@zstumgoren zstumgoren added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zstumgoren