https://github.com/alexistm/licensegenerator
Create the license.txt file for your project
https://github.com/alexistm/licensegenerator
Last synced: 24 days ago
JSON representation
Create the license.txt file for your project
- Host: GitHub
- URL: https://github.com/alexistm/licensegenerator
- Owner: AlexisTM
- License: gpl-3.0
- Created: 2017-10-18T08:13:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-18T09:26:46.000Z (over 8 years ago)
- Last Synced: 2025-03-02T14:48:43.539Z (over 1 year ago)
- Language: Python
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LicenseParser
Create the license.txt file for your project
## Usage
Create a configuration file `project.yaml`
```
license_name1:
ros_core_libraries:
title: ROS core libraries
file: list/OSRF.txt
Python:
file: list/python.txt
license_name2:
python:
title: Python executable and core libraries
file: list/python.txt
```
Execute the generator:
```bash
python LicenseGenerator.py path/to/project.yaml
```
The license files `license_name1.licenses.txt` and `license_name2.licenses.txt` are generated in the `project.yaml folder`.
The `license_name1.licenses.txt` will be:
```txt
/** ROS core libraries **/
.....(content of list/OSRF.txt)
/** Python **/
.....(content of list/python.txt)
```
## Contribute
Feel free to make a PR. The needed features are:
* Install it as an executable in the python script path
* Add it in Pypi
The optional features:
* Customize the layout
* Customize output filename
* Provide default licenses (LGPL, LGPLv2, LGPLv3, GPLv2, GPLv3, MIT, CC, BSD-3, ...)
* Provide errors for license files not found (try except, report the name of the license)