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:

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

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.8.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

licensegh-1.0.8-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file licensegh-1.0.8.tar.gz.

File metadata

  • Download URL: licensegh-1.0.8.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for licensegh-1.0.8.tar.gz
Algorithm Hash digest
SHA256 4ae472ba29a5fcd31eb26da68e93a4bc076d5c9268c652a335d361b44989117b
MD5 48b4b7e944d1f4e2a70233e8ddc5bdf3
BLAKE2b-256 25aec73f3e8ca3bf0a475ffcc2d675067c53bddd617d81eae46e68b7ee9dad44

See more details on using hashes here.

File details

Details for the file licensegh-1.0.8-py3-none-any.whl.

File metadata

  • Download URL: licensegh-1.0.8-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for licensegh-1.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 58fd82f039f873950e33f5bf6077fddfe05bdb8c12264ab3aaef78aa2a0dea8d
MD5 ab888ba354e94c7e70c1b591489f217e
BLAKE2b-256 80815ab76fcaf230b22aea937886f3e80e7f0ac35e6fd9952c17338e20f40974

See more details on using hashes here.

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