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.

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

Audit platform-dependent aspects of scrapers #249

Open
eddie-m-m opened this issue Nov 5, 2024 · 1 comment
Open

Audit platform-dependent aspects of scrapers #249

eddie-m-m opened this issue Nov 5, 2024 · 1 comment

Comments

@eddie-m-m
Copy link
Contributor

eddie-m-m commented Nov 5, 2024

Contributions to scrapers have potentially platform-dependent aspects:

A prominent case of this are pathnames for files and folders in string literals/templates, where the following are used:

  • / for *nix (linux, macos, etc.) systems ('home/myfavoriterepo/morework')
  • \ for windows. ('home\myfavoriterepo\morework')

Assumptions are made in using either of these in a given scraper, and these assumptions can impact functionality (e.g. if \ for windows is used in file creation, a *nix user may not have that file created properly on their local system when they run it).

A general audit should be done that:

  • determines each scraper's pathname conventions (and any other platform-dependent aspects)
  • updates respective README to reflect the scraper's platform assumptions
  • (possibly) recommends a best practice for all submissions going forward
@josh-chamberlain
Copy link
Contributor

This is a good idea! There's a template file for scrapers, and a general README, so we can establish best practices even if we don't edit individual scrapers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants