├── __init__.py ├── requirements.txt ├── .gitignore ├── setup.py ├── README.md ├── catchpoint.py └── LICENSE /__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # For DateTime manipulation 2 | # Version is latest at time of writing 3 | DateTime==4.1.1 4 | pytz==2016.6.1 5 | 6 | # For HTTP requests to Catchpoint Pull API 7 | # Version is latest at time of writing 8 | requests==2.11.1 9 | 10 | 11 | # Transitive libraries 12 | # This is needed so there are no version conflicts when 13 | # one downstream library does NOT specify the version it wants, 14 | # and another one does. 15 | 16 | # From DateTime 17 | zope.interface==4.3.2 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | bin/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # Installer logs 26 | pip-log.txt 27 | pip-delete-this-directory.txt 28 | 29 | # Unit test / coverage reports 30 | htmlcov/ 31 | .tox/ 32 | .coverage 33 | .cache 34 | nosetests.xml 35 | coverage.xml 36 | 37 | # Translations 38 | *.mo 39 | 40 | # Mr Developer 41 | .mr.developer.cfg 42 | .project 43 | .pydevproject 44 | 45 | # Rope 46 | .ropeproject 47 | 48 | # Django stuff: 49 | *.log 50 | *.pot 51 | 52 | # Sphinx documentation 53 | docs/_build/ 54 | 55 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | 5 | 6 | # We use the version to construct the DOWNLOAD_URL. 7 | VERSION = '0.1.1' 8 | 9 | # URL to the repository on Github. 10 | REPO_URL = 'https://github.com/jasonarewhy/catchpoint-api-python' 11 | 12 | # Github will generate a tarball as long as you tag your releases, so don't 13 | # forget to tag! 14 | DOWNLOAD_URL = ''.join((REPO_URL, '/tarball/release/', VERSION)) 15 | 16 | setup( 17 | name='catchpoint', 18 | version=VERSION, 19 | author='Jason Young', 20 | author_email='jasonarewhy@gmail.com', 21 | url=REPO_URL, 22 | download_url=DOWNLOAD_URL, 23 | license='GNU GENERAL PUBLIC LICENSE Version 2', 24 | classifiers=[ 25 | 'License :: OSI Approved :: GNU General Public License v2 (GPLv2)', 26 | 'Programming Language :: Python', 27 | 'Programming Language :: Python :: 2.7', 28 | ], 29 | install_requires=[ 30 | "datetime>=4.1", 31 | "pytz", 32 | "requests", 33 | ], 34 | description="Python module for Catchpoint REST API", 35 | py_modules=['catchpoint'], 36 | ) 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Catchpoint API Python Module 2 | 3 | ## Description 4 | Catchpoint has two types of APIs, a push (subscriber) API and a pull REST API. This module is a wrapper for the REST API (which is still in alpha as of June 2014). 5 | 6 | [API documentation](https://io.catchpoint.com/ui/Help) is available to Catchpoint customers. 7 | 8 | ## Requirements 9 | 10 | Tested on Python 2.7.5 11 | 12 | Modules: 13 | * datetime 14 | * pytz 15 | * requests 16 | 17 | ## Installation 18 | 19 | `python setup.py install` 20 | 21 | ## Usage 22 | 23 | ```python 24 | # import the module 25 | import catchpoint 26 | 27 | # define your catchpoint credentials 28 | creds = { 29 | 'client_id': 'yourclientid', 30 | 'client_secret': 'yourclientsecret' 31 | } 32 | 33 | # create a Catchpoint object 34 | cp = catchpoint.Catchpoint() 35 | 36 | # query the API, always pass the creds 37 | print cp.favorite_charts(creds) 38 | print cp.favorite_details(creds, myfav) 39 | ``` 40 | 41 | ### Methods 42 | 43 | | Method | Description | Parameters | 44 | | :------ | :------------ | :--------- | 45 | | raw | Retrieve the raw performance chart data for a given test for a time period. | creds, testid, startTime, endTime, tz="UTC" | 46 | | favorite_charts | Retrieve the list of favorite charts. | creds | 47 | | favorite_details | Retrieve the favorite chart details. | creds, favid | 48 | | favorite_data | Retrieve the data for a favorite chart, optionally overriding its timeframe or test set. | creds, favid, startTime=None, endTime=None, tz="UTC", tests=None | 49 | | nodes | Retrieve the list of nodes for the API consumer. | creds | 50 | | node | Retrieve a given node for the API consumer. | creds, node | 51 | 52 | ### Parameters 53 | 54 | | Param | Type | Description | 55 | | :---- | :--- | :---------- | 56 | | creds | dict | Contains the Catchpoint `client_id` and `client_secret` | 57 | | testid | str | The Catchpoint test ID | 58 | | favid | str | The Catchpoint favorite ID | 59 | | startTime | str or int | UTC formatted ("2014-06-19T12:51:37Z") time to begin requested dataset. Can be expressed as a negative integer when `endTime` = 'now'. | 60 | | endTime | str | UTC formatted ("2014-06-19T12:51:37Z") time to end requested dataset. Can be expressed as 'now' to use current time. | 61 | | tz | str | Optionally set the timezone to correlate to the Catchpoint test's configuration. | 62 | | tests | str | Specify a comma-separated list of tests when retreiving a favorite chart. 63 | | node | str | The Catchpoint node id. | 64 | 65 | #### Relative Time Requests 66 | Catchpoint's API requires specific UTC formatted timestamps when requesting datasets. These can be made relative by setting `startTime` to a negative integer that represents number of minutes into the past, and set `endTime` to 'now'. 67 | 68 | Example for retreiving the last 60 minutes of data: 69 | 70 | ```python 71 | cp = catchpoint.Catchpoint() 72 | myfav = "12345" 73 | startTime = -60 74 | endTime = "now" 75 | print cp.favorite_data(creds, myfav, startTime, endTime) 76 | ``` 77 | ## License 78 | 79 | GPL v2 80 | -------------------------------------------------------------------------------- /catchpoint.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import base64 3 | import datetime 4 | import pytz 5 | import requests 6 | import json 7 | 8 | 9 | class CatchpointError(Exception): 10 | pass 11 | 12 | 13 | class Catchpoint(object): 14 | 15 | def __init__( 16 | self, 17 | host="io.catchpoint.com", 18 | api_uri="ui/api/v1" 19 | ): 20 | """ 21 | Basic init method. 22 | 23 | - host (str): The host to connect to 24 | - api_uri (str): The API's connection string 25 | """ 26 | self.verbose = False 27 | self.host = host 28 | self.api_uri = api_uri 29 | self.content_type = "application/json" 30 | 31 | self._auth = False 32 | self._token = None 33 | 34 | def _debug(self, msg): 35 | """ 36 | Debug output. Set self.verbose to True to enable. 37 | """ 38 | if self.verbose: 39 | sys.stderr.write(msg + '\n') 40 | 41 | def _connection_error(self, e): 42 | msg = "Unable to reach {0}: {1}" .format(self.host, e) 43 | sys.exit(msg) 44 | 45 | def _authorize(self, creds): 46 | """ 47 | Request an auth token. 48 | 49 | - creds: dict with client_id and client_secret 50 | """ 51 | self._debug("Creating auth url...") 52 | uri = "https://{0}/ui/api/token" .format(self.host) 53 | payload = { 54 | 'grant_type': 'client_credentials', 55 | 'client_id': creds['client_id'], 56 | 'client_secret': creds['client_secret'] 57 | } 58 | 59 | # make request 60 | self._debug("Making auth request...") 61 | try: 62 | r = requests.post(uri, data=payload) 63 | except requests.ConnectionError, e: 64 | self._connection_error(e) 65 | 66 | self._debug("URL: " + r.url) 67 | data = r.json() 68 | 69 | self._token = data['access_token'] 70 | self._debug("TOKEN: " + self._token) 71 | self._auth = True 72 | 73 | def _make_request(self, uri, method='get', params=None, data=None): 74 | """ 75 | Make a request with an auth token. 76 | 77 | - uri: URI for the new Request object. 78 | - params: (optional) dict or bytes to be sent in the query string for the Request. 79 | - data: (optional) dict, bytes, or file-like object to send in the body of the Request. 80 | """ 81 | self._debug("Making request...") 82 | headers = { 83 | 'Accept': self.content_type, 84 | 'Authorization': "Bearer " + base64.b64encode(self._token) 85 | } 86 | try: 87 | if method == 'get': 88 | r = requests.get( 89 | uri, 90 | headers=headers, 91 | params=params, 92 | data=data 93 | ) 94 | if method == 'post': 95 | r = requests.post( 96 | uri, 97 | headers=headers, 98 | params=params, 99 | data=data 100 | ) 101 | if r.status_code != 200: 102 | raise CatchpointError(r.status_code, r.content) 103 | except requests.ConnectionError, e: 104 | self._connection_error(e) 105 | 106 | self._debug("URL: " + r.url) 107 | try: 108 | r_data = r.json() 109 | self._expired_token_check(r_data) 110 | except TypeError, e: 111 | return e 112 | return r_data 113 | 114 | def _expired_token_check(self, data): 115 | """ 116 | Determine whether the token is expired. While this check could 117 | technically be performed before each request, it's easier to offload 118 | retry logic onto the script using this class to avoid too many 119 | req/min. 120 | 121 | - data: The json data returned from the API call. 122 | """ 123 | if "Message" in data: 124 | if data['Message'].find("Expired token") != -1: 125 | self._debug("Token was expired and has been cleared, try again...") 126 | self._token = None 127 | self._auth = False 128 | 129 | def _format_time(self, startTime, endTime, tz): 130 | """ 131 | Format "now" time to actual UTC time and set microseconds to 0. 132 | 133 | - startTime: start time of the requested data (least recent). 134 | - endTime: end time of the requested data (most recent). 135 | - tz: Timezone in tz database format (Catchpoint uses a different format). 136 | """ 137 | if endTime is not None and startTime is not None: 138 | if endTime == "now": 139 | if not isinstance(startTime, int) and startTime >= 0: 140 | msg = "When using relative times, startTime must be a negative number (number of minutes minus 'now')." 141 | sys.exit(msg) 142 | try: 143 | endTime = datetime.datetime.now(pytz.timezone(tz)) 144 | endTime = endTime.replace(microsecond=0) 145 | except pytz.UnknownTimeZoneError: 146 | msg = "Unknown Timezone '{0}'\nUse tz database format: http://en.wikipedia.org/wiki/List_of_tz_database_time_zones" .format(tz) 147 | sys.exit(msg) 148 | startTime = endTime + datetime.timedelta(minutes=int(startTime)) 149 | startTime = startTime.strftime('%Y-%m-%dT%H:%M:%S') 150 | endTime = endTime.strftime('%Y-%m-%dT%H:%M:%S') 151 | self._debug("endTime: " + str(endTime)) 152 | self._debug("startTime: " + str(startTime)) 153 | 154 | return startTime, endTime 155 | 156 | def raw(self, creds, testid, startTime, endTime, tz="UTC"): 157 | """ 158 | Retrieve the raw performance chart data for a given test for a time period. 159 | """ 160 | if not self._auth: 161 | self._authorize(creds) 162 | 163 | startTime, endTime = self._format_time(startTime, endTime, tz) 164 | 165 | # prepare request 166 | self._debug("Creating raw_chart url...") 167 | uri = "https://{0}/{1}/performance/raw/{2}" \ 168 | .format(self.host, self.api_uri, testid) 169 | params = { 170 | 'startTime': startTime, 171 | 'endTime': endTime 172 | } 173 | 174 | return self._make_request(uri, params=params) 175 | 176 | def favorite_charts(self, creds): 177 | """ 178 | Retrieve the list of favorite charts. 179 | """ 180 | if not self._auth: 181 | self._authorize(creds) 182 | 183 | # prepare request 184 | self._debug("Creating get_favorites url...") 185 | uri = "https://{0}/{1}/performance/favoriteCharts" \ 186 | .format(self.host, self.api_uri) 187 | 188 | return self._make_request(uri) 189 | 190 | def favorite_details(self, creds, favid): 191 | """ 192 | Retrieve the favorite chart details. 193 | """ 194 | if not self._auth: 195 | self._authorize(creds) 196 | 197 | # prepare request 198 | self._debug("Creating favorite_details url...") 199 | uri = "https://{0}/{1}/performance/favoriteCharts/{2}" \ 200 | .format(self.host, self.api_uri, favid) 201 | 202 | return self._make_request(uri) 203 | 204 | def favorite_data( 205 | self, creds, favid, 206 | startTime=None, endTime=None, tz="UTC", tests=None): 207 | """ 208 | Retrieve the data for a favorite chart, optionally overriding its timeframe 209 | or test set. 210 | """ 211 | if not self._auth: 212 | self._authorize(creds) 213 | 214 | startTime, endTime = self._format_time(startTime, endTime, tz) 215 | 216 | # prepare request 217 | self._debug("Creating favorite_data url...") 218 | uri = "https://{0}/{1}/performance/favoriteCharts/{2}/data" \ 219 | .format(self.host, self.api_uri, favid) 220 | 221 | if endTime is None or startTime is None: 222 | params = None 223 | else: 224 | params = { 225 | 'startTime': startTime, 226 | 'endTime': endTime 227 | } 228 | 229 | if tests is not None: 230 | params['tests'] = tests 231 | 232 | return self._make_request(uri, params=params) 233 | 234 | def nodes(self, creds): 235 | """ 236 | Retrieve the list of nodes for the API consumer. 237 | """ 238 | if not self._auth: 239 | self._authorize(creds) 240 | 241 | # prepare request 242 | self._debug("Creating nodes url...") 243 | uri = "https://{0}/{1}/nodes" \ 244 | .format(self.host, self.api_uri) 245 | 246 | return self._make_request(uri) 247 | 248 | def node(self, creds, node): 249 | """ 250 | Retrieve a given node for the API consumer. 251 | """ 252 | if not self._auth: 253 | self._authorize(creds) 254 | 255 | self._debug("Creating node url...") 256 | uri = "https://{0}/{1}/nodes/{2}" \ 257 | .format(self.host, self.api_uri, node) 258 | 259 | return self._make_request(uri) 260 | 261 | def nodes(self, creds): 262 | """ 263 | Retrieve the list of nodes for the API consumer. 264 | """ 265 | if not self._auth: 266 | self._authorize(creds) 267 | 268 | # prepare request 269 | self._debug("Creating nodes url...") 270 | uri = "https://{0}/{1}/nodes" \ 271 | .format(self.host, self.api_uri) 272 | 273 | return self._make_request(uri) 274 | 275 | def node_group(self, creds, group): 276 | """ 277 | Retrieve a given node group for the API consumer. 278 | """ 279 | if not self._auth: 280 | self._authorize(creds) 281 | 282 | self._debug("Creating node groups url...") 283 | uri = "https://{0}/{1}/nodeGroups/{2}" \ 284 | .format(self.host, self.api_uri, group) 285 | 286 | return self._make_request(uri) 287 | 288 | def node_groups(self, creds): 289 | """ 290 | Retrieve the list of node groups for the API consumer. 291 | """ 292 | if not self._auth: 293 | self._authorize(creds) 294 | 295 | # prepare request 296 | self._debug("Creating node groups url...") 297 | uri = "https://{0}/{1}/nodeGroups" \ 298 | .format(self.host, self.api_uri) 299 | 300 | return self._make_request(uri) 301 | 302 | def product(self, creds, product): 303 | """ 304 | Retrieve a given product for the API consumer. 305 | """ 306 | if not self._auth: 307 | self._authorize(creds) 308 | 309 | self._debug("Creating product url...") 310 | uri = "https://{0}/{1}/products/{2}/allSections" \ 311 | .format(self.host, self.api_uri, product) 312 | 313 | return self._make_request(uri) 314 | 315 | def products(self, creds, params=None): 316 | """ 317 | Retrieve the list of products for the API consumer. 318 | """ 319 | if not self._auth: 320 | self._authorize(creds) 321 | 322 | # prepare request 323 | self._debug("Creating products url...") 324 | uri = "https://{}/{}/products".format( 325 | self.host, 326 | self.api_uri 327 | ) 328 | 329 | return self._make_request(uri, params=params) 330 | 331 | def product_create(self, creds, product): 332 | """ 333 | Create a new product. 334 | """ 335 | if not self._auth: 336 | self._authorize(creds) 337 | 338 | self._debug("Creating url...") 339 | uri = "https://{0}/{1}/products/0" \ 340 | .format(self.host, self.api_uri) 341 | 342 | return self._make_request( 343 | uri, 344 | method='post', 345 | data=json.dumps(product) 346 | ) 347 | 348 | def folders(self, creds, params=None): 349 | """ 350 | Retrieve the list of folders for the API consumer. 351 | """ 352 | if not self._auth: 353 | self._authorize(creds) 354 | 355 | # prepare request 356 | self._debug("Creating folders url...") 357 | uri = "https://{0}/{1}/folders".format( 358 | self.host, 359 | self.api_uri 360 | ) 361 | 362 | return self._make_request(uri, params=params) 363 | 364 | def folder(self, creds, folder): 365 | """ 366 | Retrieve a given folder for the API consumer. 367 | """ 368 | if not self._auth: 369 | self._authorize(creds) 370 | 371 | self._debug("Creating folder url...") 372 | uri = "https://{0}/{1}/folders/{2}/allSections" \ 373 | .format(self.host, self.api_uri, folder) 374 | 375 | return self._make_request(uri) 376 | 377 | def folder_create(self, creds, folder): 378 | """ 379 | Create a new folder. 380 | """ 381 | if not self._auth: 382 | self._authorize(creds) 383 | 384 | self._debug("Creating url...") 385 | uri = "https://{0}/{1}/folders/0" \ 386 | .format(self.host, self.api_uri) 387 | 388 | return self._make_request( 389 | uri, 390 | method='post', 391 | data=json.dumps(folder) 392 | ) 393 | 394 | def folder_create_schedule(self, creds, folder, schedule): 395 | """ 396 | Create a new folder. 397 | """ 398 | if not self._auth: 399 | self._authorize(creds) 400 | 401 | self._debug("Creating url...") 402 | uri = "https://{}/{}/folders/{}/scheduleSection".format( 403 | self.host, 404 | self.api_uri, 405 | folder 406 | ) 407 | 408 | return self._make_request( 409 | uri, 410 | method='post', 411 | data=json.dumps(schedule) 412 | ) 413 | 414 | def tests(self, creds, params=None): 415 | """ 416 | Retrieve the list of tests for the API consumer. 417 | """ 418 | if not self._auth: 419 | self._authorize(creds) 420 | 421 | # prepare request 422 | self._debug("Creating tests url...") 423 | uri = "https://{0}/{1}/tests" \ 424 | .format(self.host, self.api_uri) 425 | 426 | return self._make_request(uri, params=params) 427 | 428 | def test(self, creds, test): 429 | """ 430 | Retrieve a given test for the API consumer. 431 | """ 432 | if not self._auth: 433 | self._authorize(creds) 434 | 435 | self._debug("Creating test url...") 436 | uri = "https://{0}/{1}/tests/{2}/allSections" \ 437 | .format(self.host, self.api_uri, test) 438 | 439 | return self._make_request(uri) 440 | 441 | def test_create(self, creds, test): 442 | """ 443 | Create a new test. 444 | """ 445 | if not self._auth: 446 | self._authorize(creds) 447 | 448 | self._debug("Creating url...") 449 | uri = "https://{}/{}/tests/0".format( 450 | self.host, 451 | self.api_uri 452 | ) 453 | 454 | return self._make_request( 455 | uri, 456 | method='post', 457 | data=json.dumps(test) 458 | ) 459 | 460 | def test_update_status(self, creds, test_ids, body): 461 | """ 462 | Update test status. 463 | """ 464 | if not self._auth: 465 | self._authorize(creds) 466 | 467 | self._debug("Creating url...") 468 | uri = "https://{}/{}/tests/updateStatus?tests={}".format( 469 | self.host, 470 | self.api_uri, 471 | test_ids 472 | ) 473 | 474 | return self._make_request( 475 | uri, 476 | method='post', 477 | data=json.dumps(body) 478 | ) 479 | 480 | def test_instant(self, creds, test): 481 | """ 482 | Retrieve an instant test for the API consumer. 483 | """ 484 | if not self._auth: 485 | self._authorize(creds) 486 | 487 | self._debug("Creating instant test url...") 488 | uri = "https://{}/{}/onDemandTest/{}".format( 489 | self.host, 490 | self.api_uri, 491 | test 492 | ) 493 | return self._make_request(uri) 494 | 495 | def test_instant_run(self, creds, test): 496 | """ 497 | Run an instant test. 498 | """ 499 | if not self._auth: 500 | self._authorize(creds) 501 | 502 | self._debug("Creating url...") 503 | uri = "https://{}/{}/onDemandTest/0".format( 504 | self.host, 505 | self.api_uri 506 | ) 507 | 508 | return self._make_request( 509 | uri, 510 | method='post', 511 | data=json.dumps(test) 512 | ) 513 | 514 | def divisions(self, creds): 515 | """ 516 | Retrieve the list of divisions for the API consumer. 517 | """ 518 | if not self._auth: 519 | self._authorize(creds) 520 | 521 | # prepare request 522 | self._debug("Creating divisions url...") 523 | uri = "https://{0}/{1}/divisions" \ 524 | .format(self.host, self.api_uri) 525 | 526 | return self._make_request(uri) 527 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. --------------------------------------------------------------------------------