├── MANIFEST.in ├── README.rst ├── test_inputs └── katana.txt ├── .travis.yml ├── .gitattributes ├── .gitignore ├── setup.py ├── tests_pipeline_caller.py ├── README.md ├── pipeline_caller.py └── LICENSE.md /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst 2 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | SEE https://github.com/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller 2 | -------------------------------------------------------------------------------- /test_inputs/katana.txt: -------------------------------------------------------------------------------- 1 | Katana'yı saklarız, dedi Ramiz, ben giderim bahçeye, tüm yeşil erikleri toplar gelirim, sonra da erikleri komşuya götürür, ondan Katana'yı ele vermemesini isterim. 2 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - "3.6" 4 | install: pip install codecov 5 | script: nosetests -v --with-coverage --nocapture tests_pipeline_caller.py 6 | after_success: 7 | - codecov 8 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | 55 | # Sphinx documentation 56 | docs/_build/ 57 | 58 | # PyBuilder 59 | target/ 60 | 61 | #Ipython Notebook 62 | .ipynb_checkpoints 63 | 64 | #Output Files 65 | pipeline_caller_output 66 | 67 | 68 | #Token file 69 | *.token 70 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import pipeline_caller 2 | from setuptools import setup, find_packages 3 | 4 | 5 | def readme(): 6 | with open('README.rst') as f: 7 | return f.read() 8 | 9 | 10 | setup( 11 | name="ITU-Turkish-NLP-Pipeline-Caller", 12 | version=pipeline_caller.version, 13 | packages=find_packages(), 14 | py_modules=['pipeline_caller'], 15 | entry_points={ 16 | 'console_scripts': [ 17 | 'pipeline_caller = pipeline_caller:main', 18 | ], 19 | }, 20 | author="Ferit Tunçer", 21 | author_email="ferit.tuncer@autistici.org", 22 | description="A wrapper tool to use ITU Turkish NLP Pipeline API", 23 | license="GPLv2", 24 | keywords="ITU Turkish NLP Pipeline", 25 | url="https://github.com/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller", 26 | classifiers=[ 27 | 'Development Status :: 5 - Production/Stable', 28 | 'License :: OSI Approved :: GNU General Public License v2 (GPLv2)', 29 | 'Topic :: Text Processing :: Linguistic', 30 | 'Natural Language :: Turkish', 31 | 'Programming Language :: Python :: 3', 32 | 'Programming Language :: Python :: 3.6', 33 | ] 34 | ) 35 | -------------------------------------------------------------------------------- /tests_pipeline_caller.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # -*- coding: utf-8 -*- 3 | 4 | import os 5 | import re 6 | import subprocess 7 | import sys 8 | import unittest 9 | 10 | from pipeline_caller import PipelineCaller, get_token 11 | 12 | KATANA = 'Katana\'yı saklarız, dedi Ramiz, ben giderim bahçeye, tüm yeşil erikleri toplar gelirim, sonra da erikleri komşuya götürür, ondan Katana\'yı ele vermemesini isterim.' 13 | KELIME = 'kelime kelime gönderelim bakalım' 14 | UCDORT = ' Üç - dört kız başı göründü . Gülüşüp itişiyorlar . ' 15 | 16 | 17 | class Test(unittest.TestCase): 18 | def module_Vowelizer_word_test(self): 19 | caller = PipelineCaller('Vowelizer', KELIME, get_token(), 'word') 20 | 21 | r = re.compile(r'(.+?\n)', re.MULTILINE) 22 | 23 | response = caller.call() 24 | 25 | print(response) 26 | assert len(re.findall(r, response)) == 4 27 | 28 | def module_pipelineNoisy_sentence_test(self): 29 | caller = PipelineCaller('pipelineNoisy', UCDORT, get_token(), 'sentence') 30 | 31 | r1 = re.compile(r'(1)(\t.+?){7,}', re.MULTILINE) 32 | r2 = re.compile(r'(5)(\t.+?){7,}', re.MULTILINE) 33 | 34 | response = caller.call() 35 | 36 | print(response) 37 | assert len(re.findall(r1, response)) == 2 and len(re.findall(r2, response)) == 1 38 | 39 | def module_pipelineNoisy_whole_test(self): 40 | caller = PipelineCaller('pipelineNoisy', KATANA, get_token(), 'whole') 41 | 42 | r = re.compile(r'(\d+)(\t.+?){7,}', re.MULTILINE) 43 | 44 | response = caller.call() 45 | 46 | print(response) 47 | assert len(re.findall(r, response)) == 29 48 | 49 | def tool_exception_test(self): 50 | exec(open('./pipeline_caller.py').read()) 51 | 52 | def tool_noisy_test(self): 53 | # subprocess.Popen("python3 pipeline_caller.py katana.txt") 54 | script_path = "./pipeline_caller.py" 55 | subprocess.check_call( 56 | [sys.executable or 'python3', script_path, "test_inputs/katana.txt"], 57 | cwd=os.path.dirname(script_path) 58 | ) 59 | 60 | 61 | if __name__ == '__main__': 62 | unittest.main() 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | *As I no longer have time to maintain this project I am looking for collaborators to help to maintain. You can sign up by sending a pull request which fixes a bug or adds a feature.* 2 | 3 | 4 | # ITU Turkish NLP Pipeline Caller 5 | [![Build Status](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller.svg?branch=master)](https://travis-ci.org/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller) [![PyPI version](https://badge.fury.io/py/ITU-Turkish-NLP-Pipeline-Caller.svg)](https://badge.fury.io/py/ITU-Turkish-NLP-Pipeline-Caller) [![Join the chat at https://gitter.im/freecodecamp/freecodecamp](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller) [![Codacy Badge](https://api.codacy.com/project/badge/grade/6368b6f3c39d4199b2ed162b79944a27)](https://www.codacy.com/app/ferit-tuncer/ITU-Turkish-NLP-Pipeline-Caller) 6 | 7 | 8 | 9 | A Python3 wrapper tool to help using [ITU Turkish NLP Pipeline API](http://tools.nlp.itu.edu.tr/) 10 | 11 | 12 | 13 | For details of the pipeline, please check the pipeline page and the sources below. 14 | 15 | [Eryigit, Gülsen. "ITU Turkish NLP Web Service." EACL. 2014.](http://web.itu.edu.tr/gulsenc/papers/itunlp.pdf) 16 | 17 | [Gülşen Eryiğit, Joakim Nivre, and Kemal Oflazer. Dependency Parsing 18 | of Turkish. Computational Linguistics, 34 no.3, 2008.](http://www.mitpressjournals.org/doi/pdf/10.1162/coli.2008.07-017-R1-06-83) 19 | 20 | ## Usage 21 | To be able to use the pipeline, you need an **authentication token** (details on [API web page](http://tools.nlp.itu.edu.tr/)). 22 | 23 | If you experience any problem please contact with me via the [gitter chat room](https://gitter.im/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller). 24 | ### Setup 25 | 26 | This repository is tested with Python 3.4, 3.5 and 3.6 versions, but using the most up-to-date one is always better. 27 | 28 | #### Recommended way 29 | Using [PyPI](https://pypi.python.org/pypi) just run `pip3 install ITU-Turkish-NLP-Pipeline-Caller` 30 | 31 | #### Alternative way 32 | Download the latest [release](https://github.com/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller/releases), extract the archive and inside that directory simply run `python3 ./setup.py install` to install. 33 | 34 | ### As a Command Line Tool 35 | The tool reads the token from `pipeline.token` file (under the same directory with the tool) by default. 36 | 37 | Simply 38 | `pipeline_caller ` 39 | reads the input file, prints the output under `./output/output` 40 | 41 | You can select the pipeline tool by using `-t` option 42 | `pipeline_caller --tool ` 43 | default is "pipelineNoisy" 44 | 45 | You can force the encoding for I/O by using `-e` option 46 | `pipeline_caller -e ` 47 | default is your system locale 48 | 49 | You can switch processing type using `-p` option. Input text can be processed whole at once, sentence by sentence or word by word. For some tools (`isturkish` for example) in the Pipeline, word by word processing is necessary at the moment. Default type is whole at once. 50 | Example: `pipeline_caller --tool isturkish -p word` sends input text to `isturkish` tool, word by word. 51 | 52 | And you can change the output directory by using `-o` option 53 | `pipeline_caller -o ` 54 | default is "output" 55 | 56 | Also `pipeline_caller --help` shows the help menu. 57 | ### Using As a Module 58 | 59 | `import pipeline_caller` 60 | 61 | `caller = pipeline_caller.PipelineCaller()` 62 | 63 | `result = caller.call(, , )` 64 | 65 | ## Defaults (Optional) 66 | 67 | Check DEFAULTS block in the source code if you need (generally, you don't) to change one of these: 68 | 69 | `api_url = "http://tools.nlp.itu.edu.tr/SimpleApi"` 70 | 71 | `pipeline_encoding = 'UTF-8'` 72 | 73 | `token_path = "pipeline.token"` for command line tool 74 | 75 | `default_output_dir = "output"` 76 | 77 | `default_enconding = locale.getpreferredencoding(False)` default encoding in your OS, for I/O operations in command line tool 78 | 79 | `default_sentence_split_delimiter_class = "[\.\?:;!]"` for command line tool, to separate sentences and process sentence by sentence 80 | ## Special Thanks 81 | Special thanks to [Asst. Prof. Dr. Peter Schüller](https://github.com/peschue) for his great suggestions! 82 | 83 | ## Author, Copyright & License 84 | This work was a part of a [KnowLP](http://www.knowlp.com) research project. 85 | 86 | Copyright 2015-2018 Maintainers: 87 | 88 | * Ferit Tunçer, 89 | * Ülgen Sarıkavak, 90 | 91 | 92 | This program is free software; you can redistribute it and/or 93 | modify it under the terms of the GNU General Public License version 2 94 | as published by the Free Software Foundation. 95 | 96 | This program is distributed in the hope that it will be useful, 97 | but WITHOUT ANY WARRANTY; without even the implied warranty of 98 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 99 | GNU General Public License for more details. 100 | 101 | You should have received a copy of the GNU General Public License 102 | along with this program. If not, see . 103 | 104 | 105 | -------------------------------------------------------------------------------- /pipeline_caller.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | #-*- coding: utf-8 -*- 3 | 4 | name = 'ITU Turkish NLP Pipeline Caller' 5 | 6 | __copyright__ = '__copyright__ 2015-2018 Maintainers' 7 | 8 | __license__ = 'GPLv2\n\ 9 | This program is free software; you can redistribute it and/or \ 10 | modify it under the terms of the GNU General Public license version 2 \ 11 | as published by the Free Software Foundation. \ 12 | This program is distributed in the hope that it will be useful, \ 13 | but WITHOUT ANY WARRANTY; without even the implied warranty of \ 14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \ 15 | GNU General Public license for more details. \ 16 | You should have received a copy of the GNU General Public license \ 17 | along with this program. If not, see .' 18 | 19 | author0 = ('Ferit Tunçer', 'ferit@cryptolab.net') 20 | author1 = ('Ülgen Sarıkavak', 'work@ulgens.me') 21 | website = 'https://github.com/ferittuncer/ITU-Turkish-NLP-Pipeline-Caller' 22 | 23 | version = '3.0.0' 24 | 25 | import argparse 26 | import locale 27 | import os 28 | import re 29 | import time 30 | 31 | import urllib.parse 32 | import urllib.request 33 | 34 | TOKEN_PATH = "pipeline.token" 35 | TOKEN_ENVVAR = "pipeline_token" 36 | DEFAULT_ENCODING = locale.getpreferredencoding(False) 37 | DEFAULT_OUTPUT_DIR = 'output' 38 | 39 | 40 | class PipelineCaller(object): 41 | API_URL = 'http://tools.nlp.itu.edu.tr/SimpleApi' 42 | PIPELINE_ENCODING = 'UTF-8' 43 | 44 | DEFAULT_SENTENCE_SPLIT_DELIMITER_CLASS = '[\.\?:;!]' 45 | 46 | def __init__(self, tool='pipelineNoisy', text='example', token='invalid', processing_type='whole'): 47 | self.tool = tool 48 | self.text = text 49 | self.token = token 50 | self.processing_type = processing_type 51 | 52 | self.sentences = [] 53 | self.words = [] 54 | 55 | def call(self): 56 | 57 | if self.processing_type == 'whole': 58 | params = self.encode_parameters(self.text) 59 | return self.request(params) 60 | 61 | if self.processing_type == 'sentence': 62 | results = [] 63 | self.parse_sentences() 64 | 65 | for sentence in self.sentences: 66 | params = self.encode_parameters(sentence) 67 | results.append(self.request(params)) 68 | 69 | return "\n".join(results) 70 | 71 | if self.processing_type == 'word': 72 | results = [] 73 | self.parse_words() 74 | 75 | for word in self.words: 76 | params = self.encode_parameters(word) 77 | results.append(self.request(params)) 78 | 79 | return "\n".join(results) 80 | 81 | def parse_sentences(self): 82 | r = re.compile(r'(?<=(?:{}))\s+'.format(PipelineCaller.DEFAULT_SENTENCE_SPLIT_DELIMITER_CLASS)) 83 | self.sentences = r.split(self.text) 84 | 85 | if re.match('^\s*$', self.sentences[-1]): 86 | self.sentences.pop(-1) 87 | 88 | def parse_words(self): 89 | self.parse_sentences() 90 | 91 | for sentence in self.sentences: 92 | for word in sentence.split(): 93 | self.words.append(word) 94 | 95 | def encode_parameters(self, text): 96 | return urllib.parse.urlencode({'tool': self.tool, 'input': text, 'token': self.token}).encode(self.PIPELINE_ENCODING) 97 | 98 | def request(self, params): 99 | response = urllib.request.urlopen(self.API_URL, params) 100 | return response.read().decode(self.PIPELINE_ENCODING) 101 | 102 | 103 | def get_token(filename=TOKEN_PATH, envvar=TOKEN_ENVVAR): 104 | """ 105 | Returns pipeline_token for API 106 | 107 | Tries local file first, then env variable 108 | """ 109 | if os.path.isfile(filename): 110 | with open(filename) as token_file: 111 | token = token_file.readline().strip() 112 | 113 | else: 114 | token = os.environ.get(envvar) 115 | 116 | if not token: 117 | raise ValueError("No token found.\n" 118 | "{} file doesn't exist.\n{} environment variable is not set.".format(filename, envvar)) 119 | 120 | return token 121 | 122 | 123 | def get_output_path(output_dir): 124 | if not os.path.exists(output_dir): 125 | os.makedirs(output_dir) 126 | 127 | filepath = os.path.join(output_dir, 'output{0:.0f}'.format(time.time())) 128 | return filepath 129 | 130 | 131 | def conditional_info(to_be_printed, quiet): 132 | if quiet == 0: 133 | print(to_be_printed) 134 | 135 | 136 | def parse_arguments(): 137 | # epilog section is free now 138 | parser = argparse.ArgumentParser( 139 | formatter_class=argparse.RawDescriptionHelpFormatter, 140 | description='ITU Turkish NLP Pipeline Caller v{}\n\n Maintained by:\n {} {}\n {} {}\n\n {}'.format(version, *author0, *author1, website), 141 | add_help=True 142 | ) 143 | parser.add_argument('filename', help='relative input filepath') 144 | parser.add_argument('-p', '--processing-type', dest='processing_type', choices=['word', 'sentence', 'whole'], default='whole', help='Switches processing type, default is whole text at once. Alternatively, word by word or sentence by sentence processing can be selected.') 145 | parser.add_argument('-q', '--quiet', dest='quiet', action='store_true', help='no info during process') 146 | parser.add_argument('--tool', dest='tool', default='pipelineNoisy', choices=['ner', 'morphanalyzer', 'isturkish', 'morphgenerator', 'tokenizer', 'normalize', 'deasciifier', 'Vowelizer', 'DepParserFormal', 'DepParserNoisy', 'spellcheck', 'disambiguator', 'pipelineFormal', 'pipelineNoisy'], help='Switches pipeline tool which is \'pipelineNoisy\' by default') 147 | parser.add_argument('-e', '--encoding', dest='encoding', metavar='E', default=DEFAULT_ENCODING, help='force I/O to use given encoding, instead of default locale') 148 | parser.add_argument('-o', '--output', metavar='O', dest='output_dir', default=DEFAULT_OUTPUT_DIR, help='change output directory, \'{}\' by default'.format(DEFAULT_OUTPUT_DIR)) 149 | parser.add_argument('--version', action='version', version='{} {}'.format(name, version), help='version information') 150 | parser.add_argument('--license', action='version', version='{}'.format(__license__), help='license information') 151 | 152 | return parser.parse_args() 153 | 154 | 155 | def main(): 156 | args = parse_arguments() 157 | 158 | with open(args.filename, encoding=args.encoding) as input_file: 159 | text = input_file.read() 160 | 161 | output_path = get_output_path(args.output_dir) 162 | token = get_token() 163 | conditional_info('[INFO] Pipeline tool: {}'.format(args.tool), args.quiet) 164 | conditional_info('[INFO] File I/O encoding: {}'.format(args.encoding), args.quiet) 165 | conditional_info('[INFO] Output destination: .{}{}'.format(os.sep, output_path), args.quiet) 166 | 167 | start_time = time.time() 168 | 169 | caller = PipelineCaller(args.tool, text, token, args.processing_type) 170 | with open(output_path, 'w', encoding=args.encoding) as output_file: 171 | output_file.write('{}\n'.format(caller.call())) 172 | 173 | process_time = time.time() - start_time 174 | 175 | print("[DONE] It took {0:.0f} seconds to process whole text.".format(process_time)) 176 | 177 | 178 | if __name__ == '__main__': 179 | main() 180 | 181 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------