├── quack
    ├── __init__.py
    └── quack.py
├── tests
    ├── __init__.py
    ├── quack.yaml
    └── quack_tests.py
├── setup.cfg
├── test.sh
├── requirements.txt
├── .gitignore
├── .travis.yml
├── contributing.md
├── .pre-commit-config.yaml
├── setup.py
├── quack.yaml
├── README.md
└── LICENSE.txt


/quack/__init__.py:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
1 | """Quack Tests"""
2 | 


--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | description-file = README.md
3 | 


--------------------------------------------------------------------------------
/test.sh:
--------------------------------------------------------------------------------
1 | cd tests/
2 | py.test quack_tests.py --verbose
3 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | argparse
2 | codecov
3 | gitpython
4 | pre-commit
5 | pytest
6 | pytest-cov
7 | pyyaml
8 | quack
9 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .quack
 2 | .gitmodules
 3 | *.pyc
 4 | build
 5 | dist
 6 | quack.egg-info
 7 | 
 8 | subscribe
 9 | pyanalytic
10 | 
11 | sort-selected
12 | django-admin
13 | 
14 | toggleicon
15 | html2text.py


--------------------------------------------------------------------------------
/tests/quack.yaml:
--------------------------------------------------------------------------------
 1 | # Quack test build configuration.
 2 | 
 3 | name: Quack Test
 4 | 
 5 | modules:
 6 | 
 7 | profiles:
 8 |   nested_quack_test:
 9 |     tasks: ['cmd:ls']
10 |   cmd:
11 |     tasks: ['cmd:pwd', 'quack:nested_quack_test']
12 |   with_dep:
13 |     tasks: []
14 |     dependencies:
15 |       quack: 'nested_quack_test'
16 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: python
 2 | python:
 3 |   - "2.7"
 4 |   - "3.3"
 5 |   - "3.4"
 6 | # command to install dependencies
 7 | install: "pip install -r requirements.txt"
 8 | # command to run tests
 9 | script:
10 |   - cd tests
11 |   - py.test quack_tests.py --cov=../quack --verbose -s
12 | after_success: codecov
13 | notifications:
14 |   webhooks:
15 |     urls:
16 |       - http://webhook.co/w6NSGybm
17 | 


--------------------------------------------------------------------------------
/contributing.md:
--------------------------------------------------------------------------------
1 | ### Contributing to Quack
2 | 
3 | If you would like to contribute code to Quack you can do so through GitHub by forking the repository and sending a pull request.
4 | 
5 | 
6 | When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
7 | 
8 | Before your code can be accepted into the project you must also sign the Contributor License Agreement (CLA). Please contact Love Sharma <love.sharma@autodesk.com> for a copy of the CLA.
9 | 


--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
 1 | -   repo: git://github.com/pre-commit/pre-commit-hooks
 2 |     sha: 516cc9fa72ad09699f2c03ffbd0aa7f60d75b59a
 3 |     hooks:
 4 |     -   id: trailing-whitespace
 5 |     -   id: autopep8-wrapper
 6 |     -   id: check-case-conflict
 7 |     -   id: check-docstring-first
 8 |     -   id: check-json
 9 |     -   id: check-yaml
10 |     -   id: debug-statements
11 |     -   id: end-of-file-fixer
12 |     -   id: requirements-txt-fixer
13 |     -   id: detect-private-key
14 |     -   id: double-quote-string-fixer
15 |     -   id: flake8
16 | -   repo: https://github.com/zonito/command-hook.git
17 |     sha: 37d426efa47d52ce15f1c8744fa0593dbeb7b943
18 |     hooks:
19 |     -   id: command
20 |         args: [--command, 'sh test.sh']
21 | 


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | """Quack setup script."""
 2 | 
 3 | from setuptools import setup
 4 | 
 5 | setup(
 6 |     name='quack',
 7 |     version='0.1.0',
 8 |     packages=['quack'],
 9 | 
10 |     # dependencies
11 |     install_requires=[
12 |         'argparse',
13 |         'gitpython',
14 |         'pyyaml'
15 |     ],
16 | 
17 |     # metadata for upload to PyPI
18 |     author='Love Sharma',
19 |     author_email='contact@lovesharma.com',
20 |     description=('Insert specific module / folder from given '
21 |                  'repositories in yaml configurations.'),
22 |     license='MIT',
23 |     keywords='quack build submodule module dependencies'.split(),
24 |     url='https://github.com/zonito/quack',  # project homepage
25 |     download_url='https://github.com/zonito/quack/archive/0.1.0.tar.gz',
26 | 
27 |     entry_points={
28 |         'console_scripts': [
29 |             'quack=quack.quack:main'
30 |         ]
31 |     }
32 | )
33 | 


--------------------------------------------------------------------------------
/quack.yaml:
--------------------------------------------------------------------------------
 1 | # Quack build configuration.
 2 | 
 3 | name: Quack
 4 | description: Quack configuration
 5 | version: 0.0.6
 6 | gitignore: true
 7 | 
 8 | modules:
 9 |   pyanalytic:
10 |     repository: https://github.com/zonito/PyAnalytics.git
11 |     path: pyanalytics
12 |     branch: dev
13 |   subscribe:
14 |     repository: https://github.com/zonito/subscribe.git
15 |     hexsha: 9e3e9642cfea36f4ae216d27df100134920143b9
16 |   toggleicon:
17 |     repository: https://github.com/zonito/z-toggleicon.git
18 |     tag: v1.0
19 |   html2text.py:
20 |     repository: https://github.com/aaronsw/html2text.git
21 |     isfile: true
22 |     path: html2text.py
23 | 
24 | profiles:
25 |   init:
26 |     tasks: ['modules',
27 |             'quack:pyanalytic/build.yaml:update',
28 |             'cmd:pwd']
29 |   update:
30 |     tasks: ['modules:html2text.py']
31 |     dependencies:
32 |       quack: 'pyanalytic/build.yaml:update'
33 |   clean:
34 |     tasks: ['-modules']
35 | 


--------------------------------------------------------------------------------
/tests/quack_tests.py:
--------------------------------------------------------------------------------
 1 | """Unit tests."""
 2 | # pylint: disable=W0212
 3 | 
 4 | import os
 5 | from quack import quack
 6 | 
 7 | 
 8 | def test_create_dir():
 9 |     """Directory specific tests."""
10 |     quack._create_dir('qt')
11 |     quack._create_dir('qt')
12 |     assert os.path.exists('qt')
13 |     quack._remove_dir('qt')
14 |     quack._remove_dir('qt')
15 |     assert not os.path.exists('qt')
16 | 
17 | 
18 | def test_get_config():
19 |     """Test on Get configuration."""
20 |     assert isinstance(quack._get_config(), dict)
21 | 
22 | 
23 | def test_run_tasks_cmd():
24 |     """Test on run command task."""
25 |     config = quack._get_config()
26 |     profile = config.get('profiles').get('cmd', {})
27 |     assert quack._run_tasks(config, profile)['tasks'] == 2
28 | 
29 | 
30 | def test_run_with_dependencies():
31 |     """Test on run profile with dependencies."""
32 |     config = quack._get_config()
33 |     profile = config.get('profiles').get('with_dep', {})
34 |     assert quack._run_tasks(config, profile)['dependencies'] == 1
35 | 
36 | 
37 | def test_run_nested_quack():
38 |     """Test on nested quack."""
39 |     assert quack._run_nested_quack(('quack', 'nested_quack_test'))
40 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ## Quack - Reuse modules. [![Build Status](https://api.travis-ci.org/Autodesk/quack.svg)](https://travis-ci.org/Autodesk/quack)
  2 | 
  3 | #### Problem
  4 | Currently, We dont have anything which helps us in reusing open source (especialy in git repositories) code. We see code - like it - clone it - copy file / folder and put it in our project and same code gets push in our repository, why? Why code redundancies?
  5 | 
  6 | #### Solution
  7 | Should be straight forward copy paste and put third party libraries in .gitignore - simple! And there shouldnt be any complexity needed to update libraries with latest changes.
  8 | 
  9 | #### Quack Way
 10 | * Add third party repository to quack configuration yaml.
 11 | * Provide exact details (like an address) such as module / file path, hexsha, branch and tag.
 12 | * Run `quack` That's it!
 13 | 
 14 | ### Features:
 15 | * Insert any module from any git repository, as a part of your project.
 16 | * Handle dependencies - execute nested quack modules.
 17 | * Multiple profiles to deal with different level of complexity.
 18 | * Works on UNIX (Mac OS X, Linux)
 19 | 
 20 | ### Installation
 21 | There are two ways to install quack. Both should have roughly the same outcome, but have their advantages/disadvantages.
 22 | 
 23 | ##### 1) PyPI / pip
 24 | This method will always produce some stable build, but may not be the most up to date version. New functionality will come slower than building from this repo.
 25 | ```shell
 26 | $ pip install quack
 27 | ```
 28 | 
 29 | Note, depending on your computer's settings, you may need to `sudo pip install quack`.
 30 | 
 31 | ##### 2) Build from this repo
 32 | This method will always include the latest features, but sometimes will not work at all. Oops!
 33 | 
 34 | Clone the repo, then use setup.py to install the package. Note, this process will differ only slightly in a non-bash shell.
 35 | ```fish
 36 | $ git clone https://github.com/zonito/quack.git
 37 | $ cd quack
 38 | $ python setup.py install
 39 | ```
 40 | Note, depending on your computer's settings, you may need to `sudo python setup.py install`.
 41 | 
 42 | ### Examples:
 43 | 
 44 | ##### Configurations
 45 | ```yaml
 46 | name: Quack
 47 | description: Quack configuration
 48 | version: 0.0.6
 49 | gitignore: false
 50 | 
 51 | modules:
 52 |   pyanalytic:
 53 |     repository: https://github.com/zonito/PyAnalytics.git
 54 |     path: pyanalytics
 55 |     branch: dev
 56 |   subscribe:
 57 |     repository: https://github.com/zonito/subscribe.git
 58 |     hexsha: 9e3e9642cfea36f4ae216d27df100134920143b9
 59 |   toggleicon:
 60 |     repository: https://github.com/zonito/z-toggleicon.git
 61 |     tag: v1.0
 62 | 
 63 | profiles:
 64 |   init:
 65 |     tasks: ['modules',
 66 |             'quack:pyanalytic/build.yaml:update',
 67 |             'cmd:pwd']
 68 |   update:
 69 |     tasks: ['modules:subscribe']
 70 |     dependencies:
 71 |       quack: 'pyanalytic/build.yaml:update'
 72 |   clean:
 73 |     tasks: ['-modules']
 74 | ```
 75 | 
 76 | ##### Adding quack plugins to your project
 77 | 
 78 | Once you have quack installed, adding quack plugins to your project is done with the quack.yaml configuration file.
 79 | 
 80 | Add a file called quack.yaml to the root of your project. The pre-commit config file describes:
 81 | 
 82 | | properties      | Details                                                         |
 83 | |-----------------|-----------------------------------------------------------------|
 84 | | **name**        | Project name                                                    |
 85 | | **description** | Project description (Optional)                                  |
 86 | | **version**     | Project version (Optional)                                      |
 87 | | **gitignore**   | Update git ignore for sub module included (Optional, default: true)  |
 88 | | **modules**     | Declared modules used within your project. <ul><li>`folder name`:</li><ul><li>`repository`: Git repository url.</li><li>`path`: module path within given git repository</li><li>`branch`: provide branch name to checkout from git repository.</li><li>`hexsha`: Provide sha1 key to checkout till specific commits</li><li>`tag`: Provide tag to checkout till specific release tag</li><li>`isfile`: Copy file instead of creating folder.</li></ul>|
 89 | | **profiles**    | List of profiles for keep things separate for different stuffs. <ul><li> `task_name`: Default task (`init` task mandatory) </li> <ul><li>`tasks`: List of tasks or execute nested quack. </li><li>`dependencies`: List of dependencies before executing tasks</li><ul><li>`quack`: Nested quack. (Syntax: `module/quack_config.yaml:profile_name`)</li></ul></ul></ul>|
 90 | 
 91 | ##### Command
 92 | ```
 93 | $ quack
 94 | ```
 95 | Above command will look for `quack.yaml` file or create, if not found, and execute `init` profile's instructions as a default profile.
 96 | 
 97 | ```
 98 | $ quack -y quack.yaml -p update
 99 | ```
100 | You can provide your custom `yaml` file (such as `build.yaml`). Above command will execute given `update` profile within `build.yaml` configuration file.
101 | 
102 | ##### Command line arguments
103 | 
104 | * `-h`, `--help`: version splash page // usage
105 | * `-p`: `--profile`: Run specific profile. `default: init`
106 | * `-y`: `--yaml`: Provide custom yaml. `default: quack.yaml`
107 | 
108 | 
109 | ### Contributing
110 | We <3 issue submissions, and address your problem as quickly as possible!
111 | 
112 | If you want to write code:
113 | 
114 | * Fork the repository
115 | * Create your feature branch (`git checkout -b my-new-feature`)
116 | * Commit your changes (`git commit -am 'add some feature'`)
117 | * Push to your branch (`git push origin my-new-feature`)
118 | * Create a new Pull Request
119 | 
120 | ## Join Chats
121 | 
122 | * [Telegram chat](https://telegram.me/joinchat/00a5dbf000f4a67acd6b351152c86771)
123 | 
124 | ![Analytics](https://ga-beacon.appspot.com/UA-68498210-2/quack/repo)
125 | 


--------------------------------------------------------------------------------
/quack/quack.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # pylint: disable=C0325,W0603
  3 | 
  4 | """Quack!!"""
  5 | 
  6 | import argparse
  7 | import git
  8 | import os
  9 | import shutil
 10 | import subprocess
 11 | import sys
 12 | import yaml
 13 | 
 14 | 
 15 | _ARGS = None
 16 | 
 17 | 
 18 | def _setup():
 19 |     """Setup parser if executed script directly."""
 20 |     parser = argparse.ArgumentParser(description='Quack builder')
 21 |     parser.add_argument(
 22 |         '-y', '--yaml', help='Provide custom yaml. default: quack.yaml')
 23 |     parser.add_argument(
 24 |         '-p', '--profile', help='Run selected profile. default: init',
 25 |         nargs='?')
 26 |     return parser.parse_args()
 27 | 
 28 | 
 29 | def _remove_dir(directory):
 30 |     """Remove directory."""
 31 |     if os.path.exists(directory):
 32 |         shutil.rmtree(directory)
 33 |         return True
 34 |     return False
 35 | 
 36 | 
 37 | def _create_dir(directory):
 38 |     """Create directory."""
 39 |     if not os.path.exists(directory):
 40 |         os.makedirs(directory)
 41 | 
 42 | 
 43 | def _get_config():
 44 |     """Return yaml configuration."""
 45 |     yaml_file = (hasattr(_ARGS, 'yaml') and _ARGS.yaml) or 'quack.yaml'
 46 |     if os.path.isfile(yaml_file):
 47 |         with open(yaml_file) as file_pointer:
 48 |             return yaml.load(file_pointer)
 49 |     return
 50 | 
 51 | 
 52 | def _fetch_modules(config, specific_module=None):
 53 |     """Fetch git submodules."""
 54 |     module_list = config.get('modules')
 55 |     if not module_list:
 56 |         print('No modules found.')
 57 |         return
 58 |     modules = '.quack/modules'
 59 |     ignore_list = []
 60 |     _remove_dir('.git/modules/')
 61 |     _create_dir(modules)
 62 |     if config.get('gitignore') and os.path.isfile('.gitignore'):
 63 |         with open('.gitignore', 'r') as file_pointer:
 64 |             ignore_list = list(set(file_pointer.read().split('\n')))
 65 |     repo = git.Repo('.')
 66 |     for module in module_list.items():
 67 |         if specific_module and specific_module != module[0]:
 68 |             continue
 69 |         tag = module[1].get('tag')
 70 |         hexsha = module[1].get('hexsha')
 71 |         if tag and hexsha:
 72 |             print('%s: Cannot be both tag & hexsha.' % module[0])
 73 |             continue
 74 |         print('Cloning: ' + module[1]['repository'])
 75 |         sub_module = repo.create_submodule(
 76 |             module[0], modules + '/' + module[0],
 77 |             url=module[1]['repository'],
 78 |             branch=module[1].get('branch', 'master')
 79 |         )
 80 | 
 81 |         if tag:
 82 |             subprocess.call(
 83 |                 ['git', 'checkout', '--quiet', 'tags/' + tag],
 84 |                 cwd=modules + '/' + module[0])
 85 |             tag = ' (' + tag + ') '
 86 |         elif hexsha:
 87 |             subprocess.call(
 88 |                 ['git', 'checkout', '--quiet', hexsha],
 89 |                 cwd=modules + '/' + module[0])
 90 |             hexsha = ' (' + hexsha + ')'
 91 |         else:
 92 |             hexsha = ' (' + sub_module.hexsha + ')'
 93 | 
 94 |         path = module[1].get('path', '')
 95 |         from_path = '%s/%s/%s' % (modules, module[0], path)
 96 |         is_exists = os.path.exists(from_path)
 97 |         if (path and is_exists) or not path:
 98 |             if module[1].get('isfile'):
 99 |                 if os.path.isfile(module[0]):
100 |                     os.remove(module[0])
101 |                 shutil.copyfile(from_path, module[0])
102 |             else:
103 |                 _remove_dir(module[0])
104 |                 shutil.copytree(
105 |                     from_path, module[0],
106 |                     ignore=shutil.ignore_patterns('.git*'))
107 |         elif not is_exists:
108 |             print('%s folder does not exists. Skipped.' % path)
109 | 
110 |         # Remove submodule.
111 |         sub_module.remove()
112 |         if os.path.isfile('.gitmodules'):
113 |             subprocess.call('rm .gitmodules'.split())
114 |             subprocess.call('git rm --quiet --cached .gitmodules'.split())
115 | 
116 |         print('Cloned: ' + module[0] + (tag or hexsha))
117 | 
118 |         if config.get('gitignore'):
119 |             with open('.gitignore', 'a') as file_pointer:
120 |                 if module[0] not in ignore_list:
121 |                     file_pointer.write('\n' + module[0])
122 |                     ignore_list.append(module[0])
123 | 
124 | 
125 | def _clean_modules(config, specific_module=None):
126 |     """Remove all given modules."""
127 |     for module in config.get('modules').items():
128 |         if specific_module and specific_module != module[0]:
129 |             continue
130 |         if _remove_dir(module[0]):
131 |             print('Cleaned', module[0])
132 | 
133 | 
134 | def _run_nested_quack(dependency):
135 |     """Execute all required dependencies."""
136 |     if not dependency or dependency[0] != 'quack':
137 |         return
138 |     quack = dependency[1]
139 |     slash_index = quack.rfind('/')
140 |     command = ['quack']
141 |     module = '.'
142 |     if slash_index > 0:
143 |         module = quack[:slash_index]
144 |     colon_index = quack.find(':')
145 |     if len(quack) > colon_index + 1:
146 |         command.append('-p')
147 |         command.append(quack[colon_index + 1: len(quack)])
148 |     if colon_index > 0:
149 |         command.append('-y')
150 |         command.append(quack[slash_index + 1:colon_index])
151 |     print('Quack..' + module)
152 |     git.Repo.init(module)
153 |     subprocess.call(command, cwd=module)
154 |     _remove_dir(module + '/.git')
155 |     return True
156 | 
157 | 
158 | def _run_tasks(config, profile):
159 |     """Run given tasks."""
160 |     dependencies = profile.get('dependencies', {})
161 |     stats = {'tasks': 0, 'dependencies': 0}
162 |     if isinstance(dependencies, dict):
163 |         for dependency in profile.get('dependencies', {}).items():
164 |             _run_nested_quack(dependency)
165 |             stats['dependencies'] += 1
166 |     tasks = profile.get('tasks', [])
167 |     if not tasks:
168 |         print('No tasks found.')
169 |         return stats
170 |     for command in tasks:
171 |         stats['tasks'] += 1
172 |         is_negate = command[0] == '-'
173 |         if is_negate:
174 |             command = command[1:]
175 |         module = None
176 |         is_modules = command.find('modules:') == 0 or 'modules' == command
177 |         is_quack = command.find('quack:') == 0
178 |         is_cmd = command.find('cmd:') == 0
179 | 
180 |         if is_modules and command != 'modules':
181 |             module = command.replace('modules:', '')
182 |         elif is_quack:
183 |             _run_nested_quack(('quack', command.replace('quack:', '')))
184 |         elif is_cmd:
185 |             cmd = command.replace('cmd:', '')
186 |             subprocess.call(cmd.split())
187 | 
188 |         if is_modules and not is_negate:
189 |             _fetch_modules(config, module)
190 |         elif is_modules and is_negate:
191 |             _clean_modules(config, module)
192 |     return stats
193 | 
194 | 
195 | def _prompt_to_create():
196 |     """Prompt user to create quack configuration."""
197 |     pyversion = sys.version_info.major
198 |     prompt = input
199 |     if pyversion < 3:
200 |         prompt = raw_input
201 |     yes_or_no = prompt(
202 |         'No quack configuration found, do you want to create one? (y/N): ')
203 |     if yes_or_no.lower() == 'y':
204 |         project_name = prompt('Provide project name: ')
205 |         with open('quack.yaml', 'a') as file_pointer:
206 |             file_pointer.write("""name: %s
207 | modules:
208 | profiles:
209 |   init:
210 |     tasks: ['modules']""" % project_name)
211 |         return _get_config()
212 |     return
213 | 
214 | 
215 | def main():
216 |     """Entry point."""
217 |     global _ARGS
218 |     _create_dir('.quack')
219 |     if _ARGS is None:
220 |         _ARGS = _setup()
221 |     config = _get_config()
222 |     if not config:
223 |         config = _prompt_to_create()
224 |         if not config:
225 |             return
226 |     if not _ARGS.profile:
227 |         _ARGS.profile = 'init'
228 |     profile = config.get('profiles', {}).get(_ARGS.profile, {})
229 |     # print(_ARGS.profile, profile)
230 |     stats = _run_tasks(config, profile)
231 |     print('%s task(s) completed with %s dependencies.' % (
232 |         stats['tasks'], stats['dependencies']))
233 | 
234 | if __name__ == '__main__':
235 |     _ARGS = _setup()
236 |     main()
237 | 


--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
  1 | 
  2 | Copyright (c) 2015 Autodesk Inc. http://www.autodesk.com
  3 | All right reserved.
  4 | 
  5 | 
  6 | Licensed under the Apache License, Version 2.0 (the "License");
  7 | you may not use this file except in compliance with the License.
  8 | You may obtain a copy of the License at
  9 | 
 10 |    http://www.apache.org/licenses/LICENSE-2.0
 11 | 
 12 | Unless required by applicable law or agreed to in writing, software
 13 | distributed under the License is distributed on an "AS IS" BASIS,
 14 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | See the License for the specific language governing permissions and
 16 | limitations under the License.
 17 | 
 18 | 
 19 | 
 20 | Apache License
 21 |                            Version 2.0, January 2004
 22 |                         http://www.apache.org/licenses/
 23 | 
 24 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 25 | 
 26 |    1. Definitions.
 27 | 
 28 |       "License" shall mean the terms and conditions for use, reproduction,
 29 |       and distribution as defined by Sections 1 through 9 of this document.
 30 | 
 31 |       "Licensor" shall mean the copyright owner or entity authorized by
 32 |       the copyright owner that is granting the License.
 33 | 
 34 |       "Legal Entity" shall mean the union of the acting entity and all
 35 |       other entities that control, are controlled by, or are under common
 36 |       control with that entity. For the purposes of this definition,
 37 |       "control" means (i) the power, direct or indirect, to cause the
 38 |       direction or management of such entity, whether by contract or
 39 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 40 |       outstanding shares, or (iii) beneficial ownership of such entity.
 41 | 
 42 |       "You" (or "Your") shall mean an individual or Legal Entity
 43 |       exercising permissions granted by this License.
 44 | 
 45 |       "Source" form shall mean the preferred form for making modifications,
 46 |       including but not limited to software source code, documentation
 47 |       source, and configuration files.
 48 | 
 49 |       "Object" form shall mean any form resulting from mechanical
 50 |       transformation or translation of a Source form, including but
 51 |       not limited to compiled object code, generated documentation,
 52 |       and conversions to other media types.
 53 | 
 54 |       "Work" shall mean the work of authorship, whether in Source or
 55 |       Object form, made available under the License, as indicated by a
 56 |       copyright notice that is included in or attached to the work
 57 |       (an example is provided in the Appendix below).
 58 | 
 59 |       "Derivative Works" shall mean any work, whether in Source or Object
 60 |       form, that is based on (or derived from) the Work and for which the
 61 |       editorial revisions, annotations, elaborations, or other modifications
 62 |       represent, as a whole, an original work of authorship. For the purposes
 63 |       of this License, Derivative Works shall not include works that remain
 64 |       separable from, or merely link (or bind by name) to the interfaces of,
 65 |       the Work and Derivative Works thereof.
 66 | 
 67 |       "Contribution" shall mean any work of authorship, including
 68 |       the original version of the Work and any modifications or additions
 69 |       to that Work or Derivative Works thereof, that is intentionally
 70 |       submitted to Licensor for inclusion in the Work by the copyright owner
 71 |       or by an individual or Legal Entity authorized to submit on behalf of
 72 |       the copyright owner. For the purposes of this definition, "submitted"
 73 |       means any form of electronic, verbal, or written communication sent
 74 |       to the Licensor or its representatives, including but not limited to
 75 |       communication on electronic mailing lists, source code control systems,
 76 |       and issue tracking systems that are managed by, or on behalf of, the
 77 |       Licensor for the purpose of discussing and improving the Work, but
 78 |       excluding communication that is conspicuously marked or otherwise
 79 |       designated in writing by the copyright owner as "Not a Contribution."
 80 | 
 81 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 82 |       on behalf of whom a Contribution has been received by Licensor and
 83 |       subsequently incorporated within the Work.
 84 | 
 85 |    2. Grant of Copyright License. Subject to the terms and conditions of
 86 |       this License, each Contributor hereby grants to You a perpetual,
 87 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 88 |       copyright license to reproduce, prepare Derivative Works of,
 89 |       publicly display, publicly perform, sublicense, and distribute the
 90 |       Work and such Derivative Works in Source or Object form.
 91 | 
 92 |    3. Grant of Patent License. Subject to the terms and conditions of
 93 |       this License, each Contributor hereby grants to You a perpetual,
 94 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 95 |       (except as stated in this section) patent license to make, have made,
 96 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 97 |       where such license applies only to those patent claims licensable
 98 |       by such Contributor that are necessarily infringed by their
 99 |       Contribution(s) alone or by combination of their Contribution(s)
100 |       with the Work to which such Contribution(s) was submitted. If You
101 |       institute patent litigation against any entity (including a
102 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
103 |       or a Contribution incorporated within the Work constitutes direct
104 |       or contributory patent infringement, then any patent licenses
105 |       granted to You under this License for that Work shall terminate
106 |       as of the date such litigation is filed.
107 | 
108 |    4. Redistribution. You may reproduce and distribute copies of the
109 |       Work or Derivative Works thereof in any medium, with or without
110 |       modifications, and in Source or Object form, provided that You
111 |       meet the following conditions:
112 | 
113 |       (a) You must give any other recipients of the Work or
114 |           Derivative Works a copy of this License; and
115 | 
116 |       (b) You must cause any modified files to carry prominent notices
117 |           stating that You changed the files; and
118 | 
119 |       (c) You must retain, in the Source form of any Derivative Works
120 |           that You distribute, all copyright, patent, trademark, and
121 |           attribution notices from the Source form of the Work,
122 |           excluding those notices that do not pertain to any part of
123 |           the Derivative Works; and
124 | 
125 |       (d) If the Work includes a "NOTICE" text file as part of its
126 |           distribution, then any Derivative Works that You distribute must
127 |           include a readable copy of the attribution notices contained
128 |           within such NOTICE file, excluding those notices that do not
129 |           pertain to any part of the Derivative Works, in at least one
130 |           of the following places: within a NOTICE text file distributed
131 |           as part of the Derivative Works; within the Source form or
132 |           documentation, if provided along with the Derivative Works; or,
133 |           within a display generated by the Derivative Works, if and
134 |           wherever such third-party notices normally appear. The contents
135 |           of the NOTICE file are for informational purposes only and
136 |           do not modify the License. You may add Your own attribution
137 |           notices within Derivative Works that You distribute, alongside
138 |           or as an addendum to the NOTICE text from the Work, provided
139 |           that such additional attribution notices cannot be construed
140 |           as modifying the License.
141 | 
142 |       You may add Your own copyright statement to Your modifications and
143 |       may provide additional or different license terms and conditions
144 |       for use, reproduction, or distribution of Your modifications, or
145 |       for any such Derivative Works as a whole, provided Your use,
146 |       reproduction, and distribution of the Work otherwise complies with
147 |       the conditions stated in this License.
148 | 
149 |    5. Submission of Contributions. Unless You explicitly state otherwise,
150 |       any Contribution intentionally submitted for inclusion in the Work
151 |       by You to the Licensor shall be under the terms and conditions of
152 |       this License, without any additional terms or conditions.
153 |       Notwithstanding the above, nothing herein shall supersede or modify
154 |       the terms of any separate license agreement you may have executed
155 |       with Licensor regarding such Contributions.
156 | 
157 |    6. Trademarks. This License does not grant permission to use the trade
158 |       names, trademarks, service marks, or product names of the Licensor,
159 |       except as required for reasonable and customary use in describing the
160 |       origin of the Work and reproducing the content of the NOTICE file.
161 | 
162 |    7. Disclaimer of Warranty. Unless required by applicable law or
163 |       agreed to in writing, Licensor provides the Work (and each
164 |       Contributor provides its Contributions) on an "AS IS" BASIS,
165 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
166 |       implied, including, without limitation, any warranties or conditions
167 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
168 |       PARTICULAR PURPOSE. You are solely responsible for determining the
169 |       appropriateness of using or redistributing the Work and assume any
170 |       risks associated with Your exercise of permissions under this License.
171 | 
172 |    8. Limitation of Liability. In no event and under no legal theory,
173 |       whether in tort (including negligence), contract, or otherwise,
174 |       unless required by applicable law (such as deliberate and grossly
175 |       negligent acts) or agreed to in writing, shall any Contributor be
176 |       liable to You for damages, including any direct, indirect, special,
177 |       incidental, or consequential damages of any character arising as a
178 |       result of this License or out of the use or inability to use the
179 |       Work (including but not limited to damages for loss of goodwill,
180 |       work stoppage, computer failure or malfunction, or any and all
181 |       other commercial damages or losses), even if such Contributor
182 |       has been advised of the possibility of such damages.
183 | 
184 |    9. Accepting Warranty or Additional Liability. While redistributing
185 |       the Work or Derivative Works thereof, You may choose to offer,
186 |       and charge a fee for, acceptance of support, warranty, indemnity,
187 |       or other liability obligations and/or rights consistent with this
188 |       License. However, in accepting such obligations, You may act only
189 |       on Your own behalf and on Your sole responsibility, not on behalf
190 |       of any other Contributor, and only if You agree to indemnify,
191 |       defend, and hold each Contributor harmless for any liability
192 |       incurred by, or claims asserted against, such Contributor by reason
193 |       of your accepting any such warranty or additional liability.
194 | 
195 |    END OF TERMS AND CONDITIONS
196 | 
197 |    APPENDIX: How to apply the Apache License to your work.
198 | 
199 |       To apply the Apache License to your work, attach the following
200 |       boilerplate notice, with the fields enclosed by brackets "[]"
201 |       replaced with your own identifying information. (Don't include
202 |       the brackets!)  The text should be enclosed in the appropriate
203 |       comment syntax for the file format. We also recommend that a
204 |       file or class name and description of purpose be included on the
205 |       same "printed page" as the copyright notice for easier
206 |       identification within third-party archives.
207 | 
208 |    Copyright [yyyy] [name of copyright owner]
209 | 
210 |    Licensed under the Apache License, Version 2.0 (the "License");
211 |    you may not use this file except in compliance with the License.
212 |    You may obtain a copy of the License at
213 | 
214 |        http://www.apache.org/licenses/LICENSE-2.0
215 | 
216 |    Unless required by applicable law or agreed to in writing, software
217 |    distributed under the License is distributed on an "AS IS" BASIS,
218 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
219 |    See the License for the specific language governing permissions and
220 |    limitations under the License.
221 | 


--------------------------------------------------------------------------------