# licensegh
<a href="https://www.python.org/"><img alt="Python" src="https://img.shields.io/badge/-python-success?logo=python&logoColor=white"></a>
<a href="https://github.com/sauljabin/licensegh"><img alt="GitHub" src="https://img.shields.io/badge/status-active-brightgreen"></a>
<a href="https://github.com/sauljabin/licensegh/blob/main/LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/sauljabin/licensegh"></a>
<a href="https://github.com/sauljabin/licensegh/actions"><img alt="GitHub Actions" src="https://img.shields.io/github/actions/workflow/status/sauljabin/licensegh/main.yml?branch=main"></a>
<a href="https://app.codecov.io/gh/sauljabin/licensegh"><img alt="Codecov" src="https://img.shields.io/codecov/c/github/sauljabin/licensegh"></a>
<a href="https://pypi.org/project/licensegh"><img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/licensegh"></a>
<a href="https://pypi.org/project/licensegh"><img alt="Version" src="https://img.shields.io/pypi/v/licensegh"></a>
<a href="https://libraries.io/pypi/licensegh"><img alt="Dependencies" src="https://img.shields.io/librariesio/release/pypi/licensegh"></a>
<a href="https://pypi.org/project/licensegh"><img alt="Platform" src="https://img.shields.io/badge/platform-linux%20%7C%20osx-blueviolet"></a>
`licensegh` is a command line tool that generates a `LICENSE` file for a project from the [github license templates repository](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses).
## Installation
Install with pip:
```sh
pipx install licensegh
```
Upgrade with pip:
```sh
pipx upgrade licensegh
```
## Usage
> Alias lgh
Help:
```sh
licensegh -h
```
Version:
```sh
licensegh --version
```
List all licenses:
```sh
licensegh -l
```
Search licenses:
```sh
licensegh -s
```
Print a license:
```sh
licensegh -p
```
Reset github template repository:
```sh
licensegh --reset
```
Save a license:
```sh
licensegh mit
```
## Development
Installing poetry:
```sh
pipx install poetry
```
Installing development dependencies:
```sh
poetry install
```
Running unit tests:
```sh
poetry run python -m scripts.tests
```
Applying code styles:
```sh
poetry run python -m scripts.styles
```
Running code analysis:
```sh
poetry run python -m scripts.analyze
```
Running code coverage:
```sh
poetry run python -m scripts.tests-coverage
```
Running cli using `poetry`:
```sh
poetry run licensegh
```
## Release a new version
> Check https://python-poetry.org/docs/cli/#version
```shell
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/sauljabin/licensegh",
"name": "licensegh",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "lincese, choosealicense, licensegh",
"author": "Sa\u00fal Pi\u00f1a",
"author_email": "sauljabin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/25/ae/c73f3e8ca3bf0a475ffcc2d675067c53bddd617d81eae46e68b7ee9dad44/licensegh-1.0.8.tar.gz",
"platform": null,
"description": "# licensegh\n\n<a href=\"https://www.python.org/\"><img alt=\"Python\" src=\"https://img.shields.io/badge/-python-success?logo=python&logoColor=white\"></a>\n<a href=\"https://github.com/sauljabin/licensegh\"><img alt=\"GitHub\" src=\"https://img.shields.io/badge/status-active-brightgreen\"></a>\n<a href=\"https://github.com/sauljabin/licensegh/blob/main/LICENSE\"><img alt=\"MIT License\" src=\"https://img.shields.io/github/license/sauljabin/licensegh\"></a>\n<a href=\"https://github.com/sauljabin/licensegh/actions\"><img alt=\"GitHub Actions\" src=\"https://img.shields.io/github/actions/workflow/status/sauljabin/licensegh/main.yml?branch=main\"></a>\n<a href=\"https://app.codecov.io/gh/sauljabin/licensegh\"><img alt=\"Codecov\" src=\"https://img.shields.io/codecov/c/github/sauljabin/licensegh\"></a>\n<a href=\"https://pypi.org/project/licensegh\"><img alt=\"Python Versions\" src=\"https://img.shields.io/pypi/pyversions/licensegh\"></a>\n<a href=\"https://pypi.org/project/licensegh\"><img alt=\"Version\" src=\"https://img.shields.io/pypi/v/licensegh\"></a>\n<a href=\"https://libraries.io/pypi/licensegh\"><img alt=\"Dependencies\" src=\"https://img.shields.io/librariesio/release/pypi/licensegh\"></a>\n<a href=\"https://pypi.org/project/licensegh\"><img alt=\"Platform\" src=\"https://img.shields.io/badge/platform-linux%20%7C%20osx-blueviolet\"></a>\n\n`licensegh` is a command line tool that generates a `LICENSE` file for a project from the [github license templates repository](https://github.com/github/choosealicense.com/tree/gh-pages/_licenses).\n\n\n\n## Installation\n\nInstall with pip:\n```sh\npipx install licensegh\n```\n\nUpgrade with pip:\n```sh\npipx upgrade licensegh\n```\n\n## Usage\n\n> Alias lgh\n\nHelp:\n```sh\nlicensegh -h\n```\n\nVersion:\n```sh\nlicensegh --version\n```\n\nList all licenses:\n```sh\nlicensegh -l\n```\n\nSearch licenses:\n```sh\nlicensegh -s\n```\n\nPrint a license: \n```sh\nlicensegh -p\n```\n\nReset github template repository:\n```sh\nlicensegh --reset\n```\n\nSave a license:\n```sh\nlicensegh mit\n```\n\n## Development\n\nInstalling poetry:\n```sh\npipx install poetry\n```\n\nInstalling development dependencies:\n```sh\npoetry install\n```\n\nRunning unit tests:\n```sh\npoetry run python -m scripts.tests\n```\n\nApplying code styles:\n```sh\npoetry run python -m scripts.styles\n```\n\nRunning code analysis:\n```sh\npoetry run python -m scripts.analyze\n```\n\nRunning code coverage:\n```sh\npoetry run python -m scripts.tests-coverage\n```\n\nRunning cli using `poetry`:\n```sh\npoetry run licensegh\n```\n\n## Release a new version\n\n> Check https://python-poetry.org/docs/cli/#version\n\n```shell\npoetry version <major|minor|patch>\ngit add -A\ngit commit -m \"new version: $(poetry version -s)\"\ngit tag $(poetry version -s)\ngit push origin main\ngit push --tags\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "licensegh is a command line tool that generates a license file for a project from the github open source lincese templates",
"version": "1.0.8",
"project_urls": {
"Homepage": "https://github.com/sauljabin/licensegh",
"Repository": "https://github.com/sauljabin/licensegh"
},
"split_keywords": [
"lincese",
" choosealicense",
" licensegh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80815ab76fcaf230b22aea937886f3e80e7f0ac35e6fd9952c17338e20f40974",
"md5": "ab888ba354e94c7e70c1b591489f217e",
"sha256": "58fd82f039f873950e33f5bf6077fddfe05bdb8c12264ab3aaef78aa2a0dea8d"
},
"downloads": -1,
"filename": "licensegh-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ab888ba354e94c7e70c1b591489f217e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 6387,
"upload_time": "2024-07-09T16:40:56",
"upload_time_iso_8601": "2024-07-09T16:40:56.637115Z",
"url": "https://files.pythonhosted.org/packages/80/81/5ab76fcaf230b22aea937886f3e80e7f0ac35e6fd9952c17338e20f40974/licensegh-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "25aec73f3e8ca3bf0a475ffcc2d675067c53bddd617d81eae46e68b7ee9dad44",
"md5": "48b4b7e944d1f4e2a70233e8ddc5bdf3",
"sha256": "4ae472ba29a5fcd31eb26da68e93a4bc076d5c9268c652a335d361b44989117b"
},
"downloads": -1,
"filename": "licensegh-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "48b4b7e944d1f4e2a70233e8ddc5bdf3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 4535,
"upload_time": "2024-07-09T16:40:57",
"upload_time_iso_8601": "2024-07-09T16:40:57.933669Z",
"url": "https://files.pythonhosted.org/packages/25/ae/c73f3e8ca3bf0a475ffcc2d675067c53bddd617d81eae46e68b7ee9dad44/licensegh-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-09 16:40:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sauljabin",
"github_project": "licensegh",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "licensegh"
}
JSON
