README.md

licensegh

licensegh is a command line tool that generates a LICENSE file for a project from the github license templates repository.

Installation

Install with pip:

pipx install licensegh

Upgrade with pip:

pipx upgrade licensegh

Usage

Alias lgh

Help:

licensegh -h

Version:

licensegh --version

List all licenses:

licensegh -l

Search licenses:

licensegh -s

Print a license:

licensegh -p

Reset github template repository:

licensegh --reset

Save a license:

licensegh mit

Development

Installing poetry:

pipx install poetry

Installing development dependencies:

poetry install

Running unit tests:

poetry run python -m scripts.tests

Applying code styles:

poetry run python -m scripts.styles

Running code analysis:

poetry run python -m scripts.analyze

Running code coverage:

poetry run python -m scripts.tests-coverage

Running cli using poetry:

poetry run licensegh

Release a new version

Check https://python-poetry.org/docs/cli/#version

poetry version <major|minor|patch>
git add -A
git commit -m "new version: $(poetry version -s)"
git tag $(poetry version -s)
git push origin main
git push --tags