search

cc-archive / cc-link-checker

Automated link checker for legalcode and license URLs
MIT License
9 stars 13 forks source link

[CC-26] ADD RDF Checking #97

Closed Audiosutras closed 4 years ago

Audiosutras commented 4 years ago

Fixes

Fixes #96 by @TimidRobot

Description

Adds functionality for checking individual license rdfs.

Technical details

pipenv run link_checker --rdf Runs link checking for each license's rdf. pipenv run link_checker --rdf --index Runs link checking on index.rdf

Tests

pipenv run pytest

Checklist

- [x] My pull request has a descriptive title (not a vague title like `Update index.md`). - [x] My pull request targets the *default* branch of the repository (`main` or `master`). - [x] My commit messages follow [best practices][best_practices]. - [x] My code follows the established code style of the repository. - [x] I added tests for the changes I made (if applicable). - [ ] I added or updated documentation (if applicable). - [x] I tried running the project locally and verified that there are no visible errors. [best_practices]:https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 ## Developer Certificate of Origin
Developer Certificate of Origin ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 1 Letterman Drive Suite D4700 San Francisco, CA, 94129 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ```
Audiosutras commented 4 years ago

See comments for requested changes.

Non-blocking (I'll create new issues if you don't want to tackle them in this PR):

  • argparse sub-commands should be used for be deed, legalcode, and rdf. --local should be both a global and sub-command option (that inherits from global option). It may also be worth having a --no-local option for the sub-commands (ex. if a user wants to use local license files but test remote index.rdf)
  • script should be able to check everything (ex. both index.rdf and remote license RDFs) in a single run

Working on the first bullet point.

Audiosutras commented 4 years ago

@TimidRobot I have updated cc-26 to have sub-commands . I have only not added the --no-local subcommand. If possible, can you speak a bit more about this use cases. I feel based on the options we are providing with sub-commands a user could write a pipfile script that could specifically cover what the --no-local subcommand would provide. I feel --no-local could be useful if a user only want to run link_checker --local --index-no-local or something like that