https://github.com/mte90/gh-license

Scan your online repo, check if it is missing the license (or install the Git Hooks in your machine)
https://github.com/mte90/gh-license

github hacktoberfest legal license

Last synced: 5 days ago
JSON representation

Scan your online repo, check if it is missing the license (or install the Git Hooks in your machine)

• Host: GitHub
• URL: https://github.com/mte90/gh-license
• Owner: Mte90
• License: gpl-3.0
• Created: 2016-02-06T16:58:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T15:24:30.000Z (about 1 year ago)
• Last Synced: 2024-12-13T14:43:12.264Z (11 days ago)
• Topics: github, hacktoberfest, legal, license
• Language: Python
• Homepage:
• Size: 122 KB
• Stars: 44
• Watchers: 4
• Forks: 23
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHosting License

[![License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0)

This script scans every repo of a user (on GitHub/Bitbucket/GitLab or other providers available) for:

* Check if include a license file

* Download a license to the project folder (automatically execute a `git commit`)

* Adds a license badge in the readme (automatically execute a `git commit`)

* Include git hooks to check if your project has one.

Remember, without a license file your project is proprietary even if it is online!

## Install

```

pip3 install gh-license

```

In case of a git clone:

```

pip3 install -e ./folder-of-the-repo

```

_**Info:** This overwrites the `init.templatedir` global git config after creating a backup of the current value in `~/.gh-license/config.ini` with the key `templatedir` in section `main`.  

The installed git template contains a hook that will be installed every time you run `git init`. The hook reminds you to install a license if you ever forget, and disables itself after adding one._

## Example

    gh-license --scan Mte90

With this command you will get a report in a file called Mte90-github-license-report

    gh-license --scan Mte90 --provider bitbucket

With this command you will get a report in a file called Mte90-bitbucket-license-report

    gh-license --scan Mte90 --report my-report

With this command you will get a report in a file called my-report

    gh-license --license-list

With this command will be showed the licenses avalaible

    gh-license --license GPLv3

With this command, a GPLv3 license will be downloaded, a shields will be added in the readme and if Git is available a commit will be added and the changes will be pushed to the repo.

    gh-license --license GPLv3 -- origin upstream

With this command the commit will be pushed on the upstream origin

[Example of output](https://gist.github.com/Mte90/4c5ec76c94afa61983f8)