1020 spider committee on design

[joshagoldstein]

Summary

Issue: #1020

Checklist

All checks are run in GitHub Actions. You'll be able to see the results of the checks at the bottom of the pull request page after it's been opened, and you can click on any of the specific checks listed to see the output of each step and debug failures.

• [x] Tests are implemented
• [x] All tests are passing
• [x] Style checks run (see documentation for more details)
• [x] Style checks are passing
• [x] Code comments from template removed

Questions

• When running iSort, it says there is nothing to do (but runs with no error)

[LienDang]

@joshagoldstein Re iSort, if you are following the docs here, it missed the ending dot . The complete commands are:

pipenv run isort .  # to sort the imports 
pipenv run isort . --check-only  # to show the errors on the imports order without fixing them

The correct commands are on the main branch. Looks like the web site reflects the master branch though.

[joshagoldstein]

I fixed all the comments above. Please let me know if everything else looks good.

[LienDang]

Thanks @joshagoldstein. Looks good to me now!

[joshagoldstein]

Hi, I see that some checks were not successful. What can I do to fix this?

[LienDang]

@joshagoldstein In your development environment, please run the linters without --check or --check-only flag so they can fix the errors for you:

pipenv run isort .
pipenv run black .
pipenv run flake8 .

[joshagoldstein]

Hi, I ran all of those commands, and everything runs without error, isort just says it skipped one file. Additionally, looking at the error on the CI: ERROR: /home/runner/work/city-scrapers/city-scrapers/city_scrapers/spiders/chi_pubhealth.py Imports are incorrectly sorted and/or formatted.

chi_pubhealth.py is not a file I have touched so is this not my error?

[LienDang]

@joshagoldstein The linter errors are not your fault. Someone merged the code into the main branch without checking the Actions' CI errors, probably this PR Fix for CHI Pub health spider with the failing CI. Feel free to clean up the linter errors in this PR. Thanks!

[joshagoldstein]

When I try to run isort locally, I get a broken path error which I am not sure how to fix. Do you have any recommendations?

[LienDang]

When I try to run isort locally, I get a broken path error which I am not sure how to fix. Do you have any recommendations?

Can you show the error logs?