├── .gitignore ├── requirements.txt ├── screenshot.png ├── Makefile ├── README.md ├── generate.py ├── profile.pine ├── clusters.pine └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .vim 2 | venv 3 | dist 4 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | click==7.1.2 2 | Jinja2==2.11.3 3 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/akhilman/vol-poorofile/HEAD/screenshot.png -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PYTHON_CMD := python3 2 | SRC := $(wildcard *.pine) 3 | DIST := $(patsubst %.pine,dist/%.pine,${SRC}) 4 | 5 | ALL: $(DIST) 6 | 7 | dist/%.pine: %.pine 8 | mkdir -p dist 9 | $(PYTHON_CMD) generate.py $^ $@ 10 | 11 | clean: 12 | rm -f $(DIST) 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Poor man's volume profile 2 | 3 | This is an attempt to get something more or less similar to the volume profile for free. 4 | 5 | ![Screenshot](screenshot.png) 6 | 7 | 8 | ## Install 9 | 10 | * Add [Poor man's volume profile][PMVolProf] to you TradingView chart 11 | * Add [Poor man's volume clusters][PMVolClust] to you TradingView chart 12 | 13 | 14 | ## Build 15 | 16 | ```bash 17 | # install dependencies 18 | pip install -r requirements.txt 19 | # generate code 20 | make 21 | # take ready to use pine scripts from dist/ 22 | ``` 23 | 24 | [PMVolProf]: https://www.tradingview.com/script/IWdpl712-Poor-man-s-volume-profile/ 25 | [PMVolClust]: https://www.tradingview.com/script/eksYnVaP-Poor-man-s-volume-clusters/ 26 | -------------------------------------------------------------------------------- /generate.py: -------------------------------------------------------------------------------- 1 | from jinja2 import BaseLoader, Environment 2 | import click 3 | import re 4 | 5 | 6 | class KeyValueParamType(click.ParamType): 7 | name = 'key=val' 8 | 9 | def convert(self, value, param, ctx): 10 | found = re.findall(r'^(\w+?)=(.+?)$', value) 11 | if not found: 12 | self.fail(f'expected "key=value", got {value!r}') 13 | return tuple(found[0]) 14 | 15 | 16 | KEY_VAL = KeyValueParamType() 17 | 18 | 19 | def split_filter(value, delimiter=','): 20 | return str(value).split(delimiter) 21 | 22 | 23 | @click.command() 24 | @click.argument('template', type=click.File('r')) 25 | @click.argument('output', default='-', type=click.File('w')) 26 | @click.option('-o', '--option', type=KEY_VAL, multiple=True) 27 | def main(template, output, option): 28 | env = Environment(loader=BaseLoader) 29 | env.filters['split'] = split_filter 30 | templ = env.from_string(template.read()) 31 | 32 | code = templ.render(**dict(option)) 33 | code = "\n".join(map(lambda line: line.rstrip(), code.splitlines())) 34 | code = code.replace("\n\n\n", "\n\n") 35 | 36 | output.write(code) 37 | 38 | 39 | if __name__ == '__main__': 40 | # pylint: disable=no-value-for-parameter 41 | main() 42 | -------------------------------------------------------------------------------- /profile.pine: -------------------------------------------------------------------------------- 1 | // This source code is subject to the terms of the Mozilla Public License 2.0 at https://mozilla.org/MPL/2.0/ 2 | // © Ildar Akhmetgaleev (AkhIL) 3 | // See https://github.com/akhilman/vol-poorofile 4 | // vim: shiftwidth=2 tabstop=2 5 | 6 | {# Template settings -#} 7 | {% set n_rows = (n_rows or 40) | int -%} 8 | {% set block_size = (block_size or 200) | int -%} 9 | {% set profile_color = profile_color or 'gray' -%} 10 | {% set peak_size = peak_size or 5 | int -%} 11 | {% set peak_color = peak_color or 'orange' -%} 12 | {% set visual_row_width = (visual_row_width or 100) | int -%} 13 | {% set max_bars_back = (max_bars_back or 500) | int -%} 14 | 15 | //@version=4 16 | study("Poor man's volume profile", "PMVolProf", overlay=true, max_bars_back={{max_bars_back}}) 17 | 18 | block_size = input({{block_size}}, "Bars in profile block", minval=10, maxval={{max_bars_back}}) 19 | visual_row_width = input({{visual_row_width}}, "Visual row width", minval=10) 20 | show_peaks = input(true, "Show peaks") 21 | use_custom_volume_source = input(false, "Use custom volume source") 22 | volume_source_symbol = input("", "Custom volume source symbol", input.symbol) 23 | 24 | BOUNDS_COLOR = color.{{profile_color}} 25 | PROFILE_COLOR = color.new(color.{{profile_color}}, 50) 26 | PEAK_COLOR = color.new(color.{{peak_color}}, 50) 27 | 28 | custom_volume = use_custom_volume_source ? security(volume_source_symbol, timeframe.period, volume, lookahead=barmerge.lookahead_on) : volume 29 | 30 | //// 31 | // Calculate profile 32 | /// 33 | 34 | block_high = highest(high, block_size) 35 | block_low = lowest(low, block_size) 36 | float highest_row_value = 0 37 | 38 | {% for n in range(n_rows) -%} 39 | float row{{n}}_price = na 40 | int row{{n}}_width = 0 41 | float row{{n}}_value = 0.0 42 | row{{n}}_is_peak = false 43 | {% endfor %} 44 | 45 | if barstate.islast 46 | 47 | block_height = block_high - block_low 48 | row_height = block_height / {{n_rows}} 49 | 50 | {% for n in range(n_rows) -%} 51 | row{{n}}_low = block_low + row_height * {{n}} 52 | row{{n}}_high = block_low + row_height * {{n+1}} 53 | {% endfor %} 54 | 55 | for i = 0 to block_size + 1 56 | n_rows_affected = 0 57 | {% for n in range(n_rows) -%} 58 | bar_row{{n}}_value = 0.0 59 | if low[i] < row{{n}}_high and high[i] > row{{n}}_low 60 | bar_row{{n}}_value := nz(custom_volume[i]) 61 | n_rows_affected := n_rows_affected + 1 62 | {% endfor %} 63 | {% for n in range(n_rows) -%} 64 | row{{n}}_value := row{{n}}_value + (n_rows_affected != 0 ? bar_row{{n}}_value / n_rows_affected : 0) 65 | {% endfor %} 66 | 67 | {% for n in range(n_rows) -%} 68 | highest_row_value := max(highest_row_value, row{{n}}_value) 69 | {% endfor %} 70 | 71 | {% for n in range(n_rows) -%} 72 | row{{n}}_price := (row{{n}}_low + row{{n}}_high ) / 2 73 | row{{n}}_width := floor(visual_row_width * row{{n}}_value / highest_row_value) 74 | {% endfor %} 75 | 76 | {% for n in range(n_rows) -%} 77 | if {% for m in range([n-peak_size, 0]|max, [n+peak_size+1, n_rows]|min) | reject("eq", n) -%} 78 | {%- if not loop.first %} and {% endif -%} 79 | row{{n}}_value >= row{{m}}_value 80 | {%- endfor %} 81 | row{{n}}_is_peak := true 82 | {% endfor %} 83 | 84 | //// 85 | // Draw profile 86 | /// 87 | 88 | var int first_bar_time = time 89 | if barstate.isfirst 90 | first_bar_time := time 91 | 92 | var line block_high_line = line.new(bar_index, high, bar_index, high, color=BOUNDS_COLOR) 93 | var line block_low_line = line.new(bar_index, low, bar_index, low, color=BOUNDS_COLOR) 94 | {% for n in range(n_rows) -%} 95 | var label row{{n}}_label = label.new(time_close, close, "", xloc=xloc.bar_time, yloc=yloc.price, color=PROFILE_COLOR, style=label.style_label_left, size=size.auto) 96 | {% endfor %} 97 | 98 | if barstate.islast 99 | line.set_xloc(block_high_line, max(time[block_size], first_bar_time), time_close, xloc.bar_time) 100 | line.set_y1(block_high_line, block_high) 101 | line.set_y2(block_high_line, block_high) 102 | 103 | line.set_xloc(block_low_line, max(time[block_size], first_bar_time), time_close, xloc.bar_time) 104 | line.set_y1(block_low_line, block_low) 105 | line.set_y2(block_low_line, block_low) 106 | 107 | {% for n in range(n_rows) -%} 108 | row{{n}}_text = "" 109 | for i = 0 to row{{n}}_width + 1 110 | row{{n}}_text := row{{n}}_text + "#" 111 | row{{n}}_color = show_peaks and row{{n}}_is_peak ? PEAK_COLOR : PROFILE_COLOR 112 | label.set_x(row{{n}}_label, time_close) 113 | label.set_y(row{{n}}_label, row{{n}}_price) 114 | label.set_color(row{{n}}_label, row{{n}}_color) 115 | label.set_textcolor(row{{n}}_label, row{{n}}_color) 116 | label.set_text(row{{n}}_label, row{{n}}_text) 117 | {% endfor %} 118 | -------------------------------------------------------------------------------- /clusters.pine: -------------------------------------------------------------------------------- 1 | // This source code is subject to the terms of the Mozilla Public License 2.0 at https://mozilla.org/MPL/2.0/ 2 | // © Ildar Akhmetgaleev (AkhIL) 3 | // See https://github.com/akhilman/vol-poorofile 4 | // vim: shiftwidth=2 tabstop=2 5 | 6 | {# Template settings -#} 7 | {% set n_rows = (n_rows or 15) | int -%} 8 | {% set block_size = (block_size or 15) | int -%} 9 | {% set visual_row_width = (visual_row_width or 10) | float -%} 10 | {% set block_colors = (block_colors or 'purple,teal') | split(',') -%} 11 | {% set boundary_color = boundary_color or 'blue' -%} 12 | {% set vpoc_color = vpoc_color or 'orange' -%} 13 | {% set filter_size = (filter_size or 200) | int -%} 14 | {% set max_bars_back = (max_bars_back or 500) | int -%} 15 | 16 | //@version=4 17 | study("Poor man's volume clusters", "PMVolClust", overlay=true, max_bars_back={{max_bars_back}}) 18 | 19 | block_size = input({{block_size}}, "Bars in profile block", minval=10, maxval={{max_bars_back//3}}) 20 | visual_row_width = input({{visual_row_width}}, "Visual row width", minval=10) 21 | show_vpoc = input(true, "Show volume point of control") 22 | filter_size = input({{filter_size}}, "Profile maximum high pass filter size in bars") 23 | use_custom_volume_source = input(false, "Use custom volume source") 24 | volume_source_symbol = input("", "Custom volume source symbol", input.symbol) 25 | 26 | BOUNARY_COLOR = color.{{boundary_color}} 27 | {%- for color in block_colors %} 28 | PROFILE{{loop.index}}_COLOR = color.{{color}} 29 | {%- endfor %} 30 | VPOC_COLOR = color.{{vpoc_color}} 31 | 32 | custom_volume = use_custom_volume_source ? security(volume_source_symbol, timeframe.period, volume, lookahead=barmerge.lookahead_on) : volume 33 | 34 | //// 35 | // Calculate profiles 36 | /// 37 | 38 | block_index = floor(bar_index / block_size) 39 | block_bar = bar_index % block_size 40 | 41 | rolling_high = highest(block_bar + 1) 42 | rolling_low = lowest(block_bar + 1) 43 | 44 | block_high = rolling_high[block_bar+1] 45 | block_low = rolling_low[block_bar+1] 46 | 47 | // plot(block_high, color=color.green) 48 | // plot(block_low, color=color.green) 49 | 50 | block_height = (block_high - block_low) 51 | row_height = block_height / {{n_rows}} 52 | n_rows_affected = 0 53 | 54 | {% for n in range(n_rows) %} 55 | row{{n}}_low = block_low + row_height * {{n}} 56 | row{{n}}_high = block_low + row_height * {{n+1}} 57 | row{{n}}_price = (row{{n}}_low + row{{n}}_high ) / 2 58 | row{{n}}_value = 0.0 59 | if high[block_size] > row{{n}}_low and low[block_size] < row{{n}}_high 60 | row{{n}}_value := custom_volume[block_size] 61 | n_rows_affected := n_rows_affected + 1 62 | {% endfor %} 63 | 64 | {% for n in range(n_rows) -%} 65 | row{{n}}_value := row{{n}}_value / n_rows_affected / row_height 66 | {% endfor %} 67 | 68 | // plot(row0_value, color=color.red, style=plot.style_linebr) 69 | 70 | if block_bar != 0 71 | {% for n in range(n_rows) -%} 72 | row{{n}}_value := row{{n}}_value + row{{n}}_value[1] 73 | {% endfor %} 74 | 75 | float vpoc_price = na 76 | highest_row_value = 0.0 77 | if block_bar == block_size - 1 78 | {% for n in range(n_rows) -%} 79 | if highest_row_value < row{{n}}_value 80 | highest_row_value := row{{n}}_value 81 | vpoc_price := row{{n}}_price 82 | {% endfor %} 83 | else 84 | highest_row_value := highest_row_value[1] 85 | 86 | highest_row_value_avg = ema(highest_row_value, filter_size) 87 | 88 | // plot(row0_value) 89 | // plot(highest_row_value, color=color.yellow) 90 | // plot(highest_row_value_avg, color=color.blue) 91 | 92 | {% for n in range(n_rows) -%} 93 | row{{n}}_width = floor(visual_row_width * row{{n}}_value / highest_row_value_avg[block_bar+1]) 94 | {% endfor %} 95 | 96 | // plot(row0_value, color=color.red, style=plot.style_linebr, offset=-block_size) 97 | 98 | //// 99 | // Draw history blocks 100 | /// 101 | 102 | // draw boudns 103 | 104 | bounds_high_y = block_bar != block_size -1 ? block_high[block_bar+1] : na 105 | bounds_low_y = block_bar != block_size -1 ? block_low[block_bar+1] : na 106 | plot(bounds_high_y, color=BOUNARY_COLOR, style=plot.style_linebr, offset=-block_size*2, title="History block high") 107 | plot(bounds_low_y, color=BOUNARY_COLOR, style=plot.style_linebr, offset=-block_size*2, title="History block low") 108 | 109 | // draw profile 110 | 111 | {% for color in block_colors %} 112 | {% set pn = (loop.length - loop.index + 1) % loop.length + 1 -%} 113 | {% set num_colors = loop.length -%} 114 | 115 | history{{pn}}_block_bar = (block_index + {{loop.index}}) % {{num_colors}} * block_size + block_bar 116 | 117 | {% for n in range(n_rows) -%} 118 | history{{pn}}_row{{n}}_price = row{{n}}_price[history{{pn}}_block_bar+1] 119 | history{{pn}}_row{{n}}_width = min({{block_size * num_colors - 2}}, row{{n}}_width[history{{pn}}_block_bar+1]) 120 | history{{pn}}_row{{n}}_y = history{{pn}}_block_bar <= history{{pn}}_row{{n}}_width ? history{{pn}}_row{{n}}_price : na 121 | {% endfor %} 122 | 123 | {% for n in range(n_rows) -%} 124 | plot(history{{pn}}_row{{n}}_y, color=PROFILE{{pn}}_COLOR, style=plot.style_linebr, linewidth=2, offset=-block_size*2, title="History {{pn}} row {{n}}") 125 | {% endfor %} 126 | {% endfor %} 127 | 128 | // draw vpoc 129 | 130 | vpoc_y = show_vpoc ? vpoc_price : na 131 | plotshape(vpoc_y, title="VPoC", location=location.absolute, color=VPOC_COLOR, style=shape.diamond, size=size.tiny, offset=-block_size*2) 132 | 133 | //// 134 | // Caclulate and draw last three blocks 135 | /// 136 | 137 | {% for rn in range(3) -%} 138 | var line recent{{rn}}_high_line = na 139 | var line recent{{rn}}_low_line = na 140 | {% if rn < 2 %} 141 | var label recent{{rn}}_vpoc_label = na 142 | {% endif %} 143 | {% for n in range(n_rows) -%} 144 | var line recent{{rn}}_row{{n}}_line = na 145 | {% endfor -%} 146 | {% endfor %} 147 | 148 | if barstate.islast 149 | {% for rn in range(3) -%} 150 | recent{{rn}}_start_i = block_size * {{rn}} + block_bar 151 | recent{{rn}}_end_i = max(block_size * {{rn}} - (block_size - block_bar) + 1, 0) 152 | 153 | recent{{rn}}_color_n = (block_index[recent{{rn}}_end_i] + 3) % {{block_colors | length}} 154 | recent{{rn}}_color = {% for color in block_colors -%} 155 | {% if not loop.first %}else {% endif %}if recent{{rn}}_color_n == {{ loop.index - 1 }} 156 | color.{{ color }} 157 | {% endfor %} 158 | 159 | if not na(time[recent{{rn}}_start_i]) and recent{{rn}}_start_i - recent{{rn}}_end_i > 5 160 | 161 | // high/low bounds 162 | 163 | if na(recent{{rn}}_low_line) 164 | recent{{rn}}_low_line := line.new(bar_index, high, bar_index, high, color=BOUNARY_COLOR) 165 | if na(recent{{rn}}_high_line) 166 | recent{{rn}}_high_line := line.new(bar_index, low, bar_index, low, color=BOUNARY_COLOR) 167 | 168 | recent{{rn}}_block_high = rolling_high[recent{{rn}}_end_i] 169 | recent{{rn}}_block_low = rolling_low[recent{{rn}}_end_i] 170 | 171 | line.set_xloc(recent{{rn}}_low_line, time[recent{{rn}}_start_i], time[recent{{rn}}_end_i], xloc.bar_time) 172 | line.set_y1(recent{{rn}}_low_line, recent{{rn}}_block_low) 173 | line.set_y2(recent{{rn}}_low_line, recent{{rn}}_block_low) 174 | 175 | line.set_xloc(recent{{rn}}_high_line, time[recent{{rn}}_start_i], time[recent{{rn}}_end_i], xloc.bar_time) 176 | line.set_y1(recent{{rn}}_high_line, recent{{rn}}_block_high) 177 | line.set_y2(recent{{rn}}_high_line, recent{{rn}}_block_high) 178 | 179 | // calculate profile rows 180 | 181 | recent{{rn}}_block_height = recent{{rn}}_block_high - recent{{rn}}_block_low 182 | recent{{rn}}_row_height = recent{{rn}}_block_height / {{n_rows}} 183 | 184 | {% for n in range(n_rows) -%} 185 | recent{{rn}}_row{{n}}_low = recent{{rn}}_block_low + recent{{rn}}_row_height * {{n}} 186 | recent{{rn}}_row{{n}}_high = recent{{rn}}_block_low + recent{{rn}}_row_height * {{n+1}} 187 | recent{{rn}}_row{{n}}_value = 0.0 188 | {% endfor %} 189 | 190 | for i = recent{{rn}}_start_i to recent{{rn}}_end_i + 1 191 | bar_n_rows_affected = 0 192 | {% for n in range(n_rows) -%} 193 | bar_row{{n}}_value = 0.0 194 | if low[i] < recent{{rn}}_row{{n}}_high and high[i] > recent{{rn}}_row{{n}}_low 195 | bar_row{{n}}_value := custom_volume[i] 196 | bar_n_rows_affected := bar_n_rows_affected + 1 197 | {% endfor %} 198 | {% for n in range(n_rows) -%} 199 | recent{{rn}}_row{{n}}_value := recent{{rn}}_row{{n}}_value + bar_row{{n}}_value / bar_n_rows_affected / recent{{rn}}_row_height 200 | {% endfor %} 201 | 202 | recent{{rn}}_avg_i = min(recent{{rn}}_start_i + 1 + block_size * {{rn + 2}}, bar_index) 203 | {% for n in range(n_rows) -%} 204 | recent{{rn}}_row{{n}}_price = (recent{{rn}}_row{{n}}_low + recent{{rn}}_row{{n}}_high ) / 2 205 | recent{{rn}}_row{{n}}_width = floor(visual_row_width * recent{{rn}}_row{{n}}_value / highest_row_value_avg[recent{{rn}}_avg_i]) 206 | {% endfor %} 207 | 208 | // calculate vpoc 209 | 210 | float recent{{rn}}_vpoc_price = na 211 | float recent{{rn}}_highes_row_value = 0 212 | {% for n in range(n_rows) -%} 213 | if recent{{rn}}_highes_row_value < recent{{rn}}_row{{n}}_value 214 | recent{{rn}}_highes_row_value := recent{{rn}}_row{{n}}_value 215 | recent{{rn}}_vpoc_price := recent{{rn}}_row{{n}}_price 216 | {% endfor %} 217 | 218 | // draw profile rows 219 | 220 | {% for n in range(n_rows) -%} 221 | if na(recent{{rn}}_row{{n}}_line) 222 | recent{{rn}}_row{{n}}_line := line.new(bar_index, close, bar_index, close, width=2) 223 | {% endfor %} 224 | 225 | {% for n in range(n_rows) %} 226 | line.set_xloc(recent{{rn}}_row{{n}}_line, time[recent{{rn}}_start_i], time_close[max(recent{{rn}}_start_i - recent{{rn}}_row{{n}}_width, 0)], xloc.bar_time) 227 | line.set_y1(recent{{rn}}_row{{n}}_line, recent{{rn}}_row{{n}}_price) 228 | line.set_y2(recent{{rn}}_row{{n}}_line, recent{{rn}}_row{{n}}_price) 229 | line.set_color(recent{{rn}}_row{{n}}_line, recent{{rn}}_color) 230 | {% endfor %} 231 | 232 | {% if rn < 2 %} 233 | // draw vpoc 234 | 235 | if show_vpoc 236 | if na(recent{{rn}}_vpoc_label) 237 | recent{{rn}}_vpoc_label := label.new(bar_index, close, yloc=yloc.price, style=label.style_diamond, size=size.tiny, color=VPOC_COLOR) 238 | 239 | label.set_xloc(recent{{rn}}_vpoc_label, time[recent{{rn}}_start_i + 1], xloc.bar_time) 240 | label.set_y(recent{{rn}}_vpoc_label, recent{{rn}}_vpoc_price) 241 | 242 | if not show_vpoc and not na(recent{{rn}}_vpoc_label) 243 | label.delete(recent{{rn}}_vpoc_label) 244 | recent{{rn}}_vpoc_label := na 245 | {% endif %} 246 | 247 | 0 248 | 249 | else 250 | 251 | // remove unused lines 252 | 253 | if not na(recent{{rn}}_low_line) 254 | line.delete(recent{{rn}}_low_line) 255 | recent{{rn}}_low_line := na 256 | if not na(recent{{rn}}_high_line) 257 | line.delete(recent{{rn}}_high_line) 258 | recent{{rn}}_high_line := na 259 | {% if rn < 2 %} 260 | if not na(recent{{rn}}_vpoc_label) 261 | label.delete(recent{{rn}}_vpoc_label) 262 | recent{{rn}}_vpoc_label := na 263 | {% endif %} 264 | {% for n in range(n_rows) -%} 265 | if not na(recent{{rn}}_row{{n}}_line) 266 | line.delete(recent{{rn}}_row{{n}}_line) 267 | recent{{rn}}_row{{n}}_line := na 268 | {% endfor %} 269 | 270 | 0 271 | 272 | {% endfor %} 273 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | --------------------------------------------------------------------------------