Skip to content

Inserts commented open source software licenses into source code.

License

Notifications You must be signed in to change notification settings

dogoncouch/licins

Folders and files

Name Name
Last commit message
Last commit date

Latest commit

 

History

118 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

licins

licins is a tool for inserting commented software licenses into source code. It comes with modules for popular open source licenses. Use ~/.config/licins.conf for persistent options. Licenses are inserted at the beginning of files, but after any lines starting with #!.

INSTALLING

See the latest instructions on the releases page .

OPTIONS

 usage: licins [-h] [--list] [-l LICENSE] [-t LICTYPE] [-c COMMENT] [-C COMMENTEND] [-d PROGDESC] [-n CNAME] [-y CYEAR] [-p PREFIX] [-e ENCODING] [-s SIGNATURE] [FILE [FILE ...]] positional arguments: FILE           specify files in which to insert licenses optional arguments: -h, --help      show this help message and exit --version       show program's version number and exit --list          return a list of available licenses -l LICENSE      set which license to use -t LICTYPE     set license type -c COMMENT      set the comment string -C COMMENTEND   set the comment end string -d PROGDESC     set a program description line -n CNAME        set the copyright name -y CYEAR       set the copyright year (default: current year) -p PREFIX      set the first line (e.g. '#!/ bin/bash)' -e ENCODING     add an encoding line -s SIGNATURE   add a signature line to follow the (c) name Always put multi-word option arguments in single quotes! Use ~/.config/licins.conf for persistent options.
 ==== Available license modules: ==== apache    : The Apache 2.0 license bsd2      : The Berkeley Software Distribution license v2 bsd3      : The Berkeley Software Distribution license v3 gfdl1-2   : The GNU Free Documentation License v1.2 gfdl1-3   : The GNU Free Documentation License v1.3 gpl2      : The GNU General Public License v2+ gpl3      : The Gnu General Public License v3 lgpl2     : The GNU Library General Public License v2+ lgpl2-1   : The GNU Library General Public License v2.1+ lgpl3     : The GNU Library General Public License v3 mit       : The MIT License

EXAMPLES

 licins -l mit -n 'Dan Persons' -p '#!/usr/bin/env python' *.py licins -l gpl2 -n 'John Exampleton' -c '/*' -C '*/' example.c licins -l gpl3 -t full -c '' LICENSE licins iwrotethisawhileago.pl licins *.py

AUTHOR

 Dan Persons ( dpersonsdev@gmail.com )

COPYRIGHT

MIT License

Copyright (c) 2017 Dan Persons ( dpersonsdev@gmail.com )

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.