Update docs and tidy up debug prints

softwaresaved / fuji

FAIRsFAIR Research Data Object Assessment Service

MIT License

0 stars 1 forks source link

Update docs and tidy up debug prints #21

Closed karacolada closed 5 months ago

karacolada commented 6 months ago

Get current code ready for an initial PR.

karacolada commented 6 months ago

Make running Github harvester optional or deal with the need for the token some other way.

karacolada commented 6 months ago

Actions:

[x] remove debugging prints
[x] update documentation with running notes
[x] fix reliance on GitHub access token, document, make optional like datacite stuff 🚧
[x] update requirements for pygithub in setup scripts, check docker
[x] check why CI fails - it doesn't!
[x] create a new branch without following files: notes.md, start-dev.sh
[x] add possibility to run GH harvester without token?
[x] add evaluation test for FAIR4RS metrics (tests/functional)

karacolada commented 6 months ago

Adding use_github to work like use_datacite requires changing the API, and that requires re-generating some of the auto-generated code for classes like Body. I tried running

java -jar swagger-codegen-cli.jar generate -i http://localhost:1071/fuji/api/v1/openapi.json -l python -o ../SSI/fuji/

but that doesn't produce the results I'd expect. Need to find out more about how to run it properly.

karacolada commented 5 months ago

Done! PR created here. Continuing development on the dev branch.