Skip to main content

licensegh is a command line tool that generates a license file for a project from the github open source lincese templates

Project description

licensegh

Python GitHub MIT License GitHub Actions Codecov Python Versions Version Dependencies Platform

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

https://raw.githubusercontent.com/sauljabin/licensegh/main/screenshots/options.png

Installation

Install with pip:

pip install licensegh

Upgrade with pip:

pip install --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:

pip 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 "bumping version to $(poetry version -s)"
git tag $(poetry version -s)
git push origin main
git push --tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

licensegh-1.0.3.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

licensegh-1.0.3-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page