search

cc-archive / cc-link-checker

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

[CC-21] Package link_checker for installation in other projects #98

Closed Audiosutras closed 4 years ago

Audiosutras commented 4 years ago

Description

This PR packages cc-link-checker to be used in other projects as the package link_checker.

Technical details

cc-link-checker can be run traditionally by using pipenv run link_checker and tests are still run as pipenv run pytest.

If you would like to do work that targets the distribution of link_checker. You will have to:

  1. create a virtualenv (this is preferable so you can test, make changes, and then destroy the virtualenv when you're done).
  2. run python setup.py install
  3. run link_checker

Tests

Install link_checker and confirm that it works.

pip install git+https://github.com/creativecommons/cc-link-checker.git@498e29268fa5bb7c2397f268a7f32c22617cf878#egg=link_checker

Note: 498e29268fa5bb7c2397f268a7f32c22617cf878 is a particular commit that we are targeting. Once this PR is approved it is recommended that link_checker is included in projects as so:

pip install git+https://github.com/creativecommons/cc-link-checker.git@master#egg=link_checker

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`). - [ ] My commit messages follow [best practices][best_practices]. - [x] My code follows the established code style of the repository. - [ ] 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. ```
TimidRobot commented 4 years ago

I believe I have updated the PR to play better with pipenv.

The updated pip install command is:

pip install https://github.com/creativecommons/cc-link-checker/archive/cc-21-packageproject/master.zip

and after merge it will be:

pip install https://github.com/creativecommons/cc-link-checker/archive/master.zip