Page MenuHomeSoftware Heritage

README.md: Update requirements and document how to run the tests
ClosedPublic

Authored by anlambert on Mon, Aug 26, 5:13 PM.

Details

Summary

The details on how to run the backend and frontend tests of swh-web were
missing in the README. So add a section documenting the corresponding make
targets to easily run the those tests.

Depends on D1915

Diff Detail

Repository
rDWAPPS Web applications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Mon, Aug 26, 5:13 PM
vlorentz accepted this revision.Wed, Aug 28, 10:37 AM

I think it would be good to add fast in the name of targets that aren't full, so it's more obvious they don't run all the tests.

README.md
35–47

This should be a pip command using the requirement files, or it will get out of date

This revision is now accepted and ready to land.Wed, Aug 28, 10:37 AM

I think it would be good to add fast in the name of targets that aren't full, so it's more obvious they don't run all the tests

I prefer to leave them like that to keep their name short. Plus, those make targets will be replaced by a proper Python CLI soon.

README.md
35–47

Ack, I will replace those lists by a link to the requirement files

I prefer to leave them like that to keep their name short.

Shouldn't be an issue with autocomplete

anlambert updated this revision to Diff 6436.Wed, Aug 28, 11:00 AM

Update: Rebase and replace requirement lists by links to requirement files

vlorentz added inline comments.Wed, Aug 28, 11:09 AM
README.md
35–47

It could help to mention they can be installed with pip -r requirements.txt

anlambert updated this revision to Diff 6437.Wed, Aug 28, 11:29 AM

Update: rebase and add pip command invocation for installing depedencies

This revision was automatically updated to reflect the committed changes.