https://github.com/neuraxio/python-requirements-license-checker
https://github.com/neuraxio/python-requirements-license-checker
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/neuraxio/python-requirements-license-checker
- Owner: Neuraxio
- Created: 2021-06-30T18:54:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-26T20:55:42.000Z (over 4 years ago)
- Last Synced: 2025-03-15T07:29:13.815Z (10 months ago)
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python Requirements License Checker
## Installation Instructions
To add the license checker to your project's main branch, assuming your main branch is called `main`, do the following when your console is located in the root of your GitHub project in your local computer:
```bash
git remote add license-checker git@github.com:Neuraxio/Python-Requirements-License-Checker.git
git fetch --all
git checkout action
git pull license-checker action
git checkout main
git merge action --allow-unrelated-histories
git push origin main
```
You may edit the line 4 and 7 of your copy of the file `./.github/workflows/python_license_checker.yml` to change the branch on which the action happen.
You may as well change the checked licenses at lines 13-18 of `./.github/workflows/license_checker_v2.py`.
## Example
You can see an example of the action in the example branch. Do not use the python `python_license_checker.yml` file in that branch because it has been modified to execute on push and pull request on that specific branch only. You can push changes to the `requirements.txt` file of your fork or copy of this example branch to test it and visualize the checks in your project's GitHub UI.