├── CNAME ├── .gitignore ├── serve.sh ├── dev-requirements.txt ├── .github └── workflows │ └── test.yml ├── tests └── test_datasette_lite.py ├── webworker.js ├── README.md ├── index.html └── LICENSE /CNAME: -------------------------------------------------------------------------------- 1 | lite.datasette.io -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .DS_Store 3 | 4 | -------------------------------------------------------------------------------- /serve.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | python3 -m http.server 8009 3 | -------------------------------------------------------------------------------- /dev-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest-playwright==0.3.0 2 | playwright==1.24.0 3 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v3 15 | - name: Set up Python 3.10 16 | uses: actions/setup-python@v3 17 | with: 18 | python-version: "3.10" 19 | cache: 'pip' 20 | cache-dependency-path: '**/dev-requirements.txt' 21 | - name: Cache Playwright browsers 22 | uses: actions/cache@v3 23 | with: 24 | path: ~/.cache/ms-playwright/ 25 | key: ${{ runner.os }}-browsers 26 | - name: Install dependencies 27 | run: | 28 | pip install -r dev-requirements.txt 29 | playwright install 30 | - name: Run test 31 | run: | 32 | pytest 33 | -------------------------------------------------------------------------------- /tests/test_datasette_lite.py: -------------------------------------------------------------------------------- 1 | from playwright.sync_api import Browser, Page, expect 2 | from subprocess import Popen, PIPE 3 | import pathlib 4 | import pytest 5 | import time 6 | from http.client import HTTPConnection 7 | 8 | root = pathlib.Path(__file__).parent.parent.absolute() 9 | 10 | 11 | @pytest.fixture(scope="module") 12 | def static_server(): 13 | process = Popen( 14 | ["python", "-m", "http.server", "8123", "--directory", root], stdout=PIPE 15 | ) 16 | retries = 5 17 | while retries > 0: 18 | conn = HTTPConnection("localhost:8123") 19 | try: 20 | conn.request("HEAD", "/") 21 | response = conn.getresponse() 22 | if response is not None: 23 | yield process 24 | break 25 | except ConnectionRefusedError: 26 | time.sleep(1) 27 | retries -= 1 28 | 29 | if not retries: 30 | raise RuntimeError("Failed to start http server") 31 | else: 32 | process.terminate() 33 | process.wait() 34 | 35 | 36 | @pytest.fixture(scope="module") 37 | def dslite(static_server, browser: Browser) -> Page: 38 | page = browser.new_page() 39 | page.goto("http://localhost:8123/") 40 | loading = page.locator("#loading-indicator") 41 | expect(loading).to_have_css("display", "block") 42 | # Give it up to 60s to finish loading 43 | expect(loading).to_have_css("display", "none", timeout=60 * 1000) 44 | return page 45 | 46 | 47 | def test_initial_load(dslite: Page): 48 | expect(dslite.locator("#loading-indicator")).to_have_css("display", "none") 49 | 50 | 51 | def test_has_two_databases(dslite: Page): 52 | assert [el.inner_text() for el in dslite.query_selector_all("h2")] == [ 53 | "fixtures", 54 | "content", 55 | ] 56 | 57 | 58 | def test_navigate_to_database(dslite: Page): 59 | h2 = dslite.query_selector("h2") 60 | assert h2.inner_text() == "fixtures" 61 | h2.query_selector("a").click() 62 | expect(dslite).to_have_title("fixtures") 63 | dslite.query_selector("textarea#sql-editor").fill( 64 | "SELECT * FROM no_primary_key limit 1" 65 | ) 66 | dslite.query_selector("input[type=submit]").click() 67 | expect(dslite).to_have_title("fixtures: SELECT * FROM no_primary_key limit 1") 68 | table = dslite.query_selector("table.rows-and-columns") 69 | table_html = "".join(table.inner_html().split()) 70 | assert table_html == ( 71 | 'content' 72 | 'ab' 73 | 'c' 74 | '1a1' 75 | 'b1c1' 76 | ) 77 | -------------------------------------------------------------------------------- /webworker.js: -------------------------------------------------------------------------------- 1 | importScripts("https://cdn.jsdelivr.net/pyodide/v0.20.0/full/pyodide.js"); 2 | 3 | function log(line) { 4 | console.log({line}) 5 | self.postMessage({type: 'log', line: line}); 6 | } 7 | 8 | async function startDatasette(settings) { 9 | let toLoad = []; 10 | let csvs = []; 11 | let sqls = []; 12 | let needsDataDb = false; 13 | let shouldLoadDefaults = true; 14 | if (settings.initialUrl) { 15 | let name = settings.initialUrl.split('.db')[0].split('/').slice(-1)[0]; 16 | toLoad.push([name, settings.initialUrl]); 17 | shouldLoadDefaults = false; 18 | } 19 | if (settings.csvUrls && settings.csvUrls.length) { 20 | csvs = settings.csvUrls; 21 | needsDataDb = true; 22 | shouldLoadDefaults = false; 23 | } 24 | if (settings.sqlUrls && settings.sqlUrls.length) { 25 | sqls = settings.sqlUrls; 26 | needsDataDb = true; 27 | shouldLoadDefaults = false; 28 | } 29 | if (needsDataDb) { 30 | toLoad.push(["data.db", 0]); 31 | } 32 | if (shouldLoadDefaults) { 33 | toLoad.push(["fixtures.db", "https://latest.datasette.io/fixtures.db"]); 34 | toLoad.push(["content.db", "https://datasette.io/content.db"]); 35 | } 36 | self.pyodide = await loadPyodide({ 37 | indexURL: "https://cdn.jsdelivr.net/pyodide/v0.20.0/full/" 38 | }); 39 | await pyodide.loadPackage('micropip', log); 40 | await pyodide.loadPackage('ssl', log); 41 | await pyodide.loadPackage('setuptools', log); // For pkg_resources 42 | try { 43 | await self.pyodide.runPythonAsync(` 44 | # Grab that fixtures.db database 45 | import sqlite3 46 | from pyodide.http import pyfetch 47 | names = [] 48 | for name, url in ${JSON.stringify(toLoad)}: 49 | if url: 50 | response = await pyfetch(url) 51 | with open(name, "wb") as fp: 52 | fp.write(await response.bytes()) 53 | else: 54 | sqlite3.connect(name).execute("vacuum") 55 | names.append(name) 56 | 57 | import micropip 58 | # Workaround for Requested 'h11<0.13,>=0.11', but h11==0.13.0 is already installed 59 | await micropip.install("h11==0.12.0") 60 | await micropip.install("datasette") 61 | # Install any extra ?install= dependencies 62 | install_urls = ${JSON.stringify(settings.installUrls)} 63 | if install_urls: 64 | for install_url in install_urls: 65 | await micropip.install(install_url) 66 | # Execute any ?sql=URL SQL 67 | sqls = ${JSON.stringify(sqls)} 68 | if sqls: 69 | for sql_url in sqls: 70 | # Fetch that SQL and execute it 71 | response = await pyfetch(sql_url) 72 | sql = await response.string() 73 | sqlite3.connect("data.db").executescript(sql) 74 | # Import data from ?csv=URL CSV files 75 | csvs = ${JSON.stringify(csvs)} 76 | if csvs: 77 | await micropip.install("sqlite-utils==3.28") 78 | import sqlite_utils 79 | from sqlite_utils.utils import rows_from_file, TypeTracker, Format 80 | db = sqlite_utils.Database("data.db") 81 | table_names = set() 82 | for csv_url in csvs: 83 | # Derive table name from CSV URL 84 | bit = csv_url.split("/")[-1].split(".")[0].split("?")[0] 85 | bit = bit.strip() 86 | if not bit: 87 | bit = "table" 88 | prefix = 0 89 | base_bit = bit 90 | while bit in table_names: 91 | prefix += 1 92 | bit = "{}_{}".format(base_bit, prefix) 93 | table_names.add(bit) 94 | tracker = TypeTracker() 95 | response = await pyfetch(csv_url) 96 | with open("csv.csv", "wb") as fp: 97 | fp.write(await response.bytes()) 98 | db[bit].insert_all( 99 | tracker.wrap(rows_from_file(open("csv.csv", "rb"), Format.CSV)[0]) 100 | ) 101 | db[bit].transform( 102 | types=tracker.types 103 | ) 104 | from datasette.app import Datasette 105 | ds = Datasette(names, settings={ 106 | "num_sql_threads": 0, 107 | }, metadata = { 108 | "about": "Datasette Lite", 109 | "about_url": "https://github.com/simonw/datasette-lite" 110 | }) 111 | await ds.invoke_startup() 112 | `); 113 | datasetteLiteReady(); 114 | } catch (error) { 115 | self.postMessage({error: error.message}); 116 | } 117 | } 118 | 119 | // Outside promise pattern 120 | // https://github.com/simonw/datasette-lite/issues/25#issuecomment-1116948381 121 | let datasetteLiteReady; 122 | let readyPromise = new Promise(function(resolve) { 123 | datasetteLiteReady = resolve; 124 | }); 125 | 126 | self.onmessage = async (event) => { 127 | console.log({event, data: event.data}); 128 | if (event.data.type == 'startup') { 129 | await startDatasette(event.data); 130 | return; 131 | } 132 | // make sure loading is done 133 | await readyPromise; 134 | console.log(event, event.data); 135 | try { 136 | let [status, contentType, text] = await self.pyodide.runPythonAsync( 137 | ` 138 | import json 139 | response = await ds.client.get( 140 | ${JSON.stringify(event.data.path)}, 141 | follow_redirects=True 142 | ) 143 | [response.status_code, response.headers.get("content-type"), response.text] 144 | ` 145 | ); 146 | self.postMessage({status, contentType, text}); 147 | } catch (error) { 148 | self.postMessage({error: error.message}); 149 | } 150 | }; 151 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Datasette Lite 2 | 3 | Datasette running in your browser using WebAssembly and [Pyodide](https://pyodide.org) 4 | 5 | Live tool: https://lite.datasette.io/ 6 | 7 | More about this project: 8 | 9 | - [Datasette Lite: a server-side Python web application running in a browser](https://simonwillison.net/2022/May/4/datasette-lite/) 10 | - [Joining CSV files in your browser using Datasette Lite](https://simonwillison.net/2022/Jun/20/datasette-lite-csvs/) 11 | 12 | ## How this works 13 | 14 | Datasette Lite runs the full server-side Datasette Python web application directly in your browser, using the [Pyodide](https://pyodide.org) build of Python compiled to WebAssembly. 15 | 16 | When you launch the demo, your browser will download and start executing a full Python interpreter, install the [datasette](https://pypi.org/project/datasette/) package (and its dependencies), download one or more SQLite database files and start the application running in a browser window (actually a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers) attached to that window). 17 | 18 | ## Loading CSV data 19 | 20 | You can load data from a CSV file hosted online (provided it allows `access-control-allow-origin: *`) by passing that URL as a `?csv=` parameter - or by clicking the "Load CSV by URL" button and pasting in a URL. 21 | 22 | This example loads a CSV of college fight songs from the [fivethirtyeight/data](https://github.com/fivethirtyeight/data/blob/master/fight-songs/README.md) GitHub repository: 23 | 24 | - https://lite.datasette.io/?csv=https%3A%2F%2Fraw.githubusercontent.com%2Ffivethirtyeight%2Fdata%2Fmaster%2Ffight-songs%2Ffight-songs.csv 25 | 26 | You can pass `?csv=` multiple times to load more than one CSV file. You can then execute SQL joins to combine that data. 27 | 28 | This example loads [the latest Covid-19 per-county data](https://github.com/nytimes/covid-19-data) from the NY Times, the 2019 county populations data from the US Census, joins them on FIPS code and runs a query that calculates cases per million across that data: 29 | 30 | [https://lite.datasette.io/?csv=https://raw.githubusercontent.com/nytimes/covid-19-data/master/us-counties-recent.csv&csv=https://raw.githubusercontent.com/simonw/covid-19-datasette/main/us_census_county_populations_2019.csv#/data?sql=select%0A++%5Bus-counties-recent%5D.*%2C%0A++us_census_county_populations_2019.population%2C%0A++1.0+*+%5Bus-counties-recent%5D.cases+%2F+us_census_county_populations_2019.population+*+1000000+as+cases_per_million%0Afrom%0A++%5Bus-counties-recent%5D%0A++join+us_census_county_populations_2019+on+us_census_county_populations_2019.fips+%3D+%5Bus-counties-recent%5D.fips%0Awhere%0A++population+%3E+10000%0Aorder+by%0A++cases_per_million+desc 31 | ](https://lite.datasette.io/?csv=https://raw.githubusercontent.com/nytimes/covid-19-data/master/us-counties-recent.csv&csv=https://raw.githubusercontent.com/simonw/covid-19-datasette/main/us_census_county_populations_2019.csv#/data?sql=select%0A++%5Bus-counties-recent%5D.*%2C%0A++us_census_county_populations_2019.population%2C%0A++1.0+*+%5Bus-counties-recent%5D.cases+%2F+us_census_county_populations_2019.population+*+1000000+as+cases_per_million%0Afrom%0A++%5Bus-counties-recent%5D%0A++join+us_census_county_populations_2019+on+us_census_county_populations_2019.fips+%3D+%5Bus-counties-recent%5D.fips%0Awhere%0A++date+%3D+%28select+max%28date%29+from+%5Bus-counties-recent%5D%29%0Aorder+by%0A++cases_per_million+desc) 32 | 33 | ## Loading SQLite databases 34 | 35 | You can use this tool to open any SQLite database file that is hosted online and served with a `access-control-allow-origin: *` CORS header. Files served by GitHub Pages automatically include this header, as do database files that have been published online [using datasette publish](https://docs.datasette.io/en/stable/publish.html). 36 | 37 | Copy the URL to the `.db` file and either paste it into the "Load SQLite DB by URL" prompt, or construct a URL like the following: 38 | 39 | https://lite.datasette.io/?url=https://latest.datasette.io/fixtures.db 40 | 41 | Some examples to try out: 42 | 43 | - [Global Power Plants](https://lite.datasette.io/?url=https://global-power-plants.datasettes.com/global-power-plants.db) - 33,000 power plants around the world 44 | - [United States members of congress](https://lite.datasette.io/?url=https://congress-legislators.datasettes.com/legislators.db) - the example database from the [Learn SQL with Datasette](https://datasette.io/tutorials/learn-sql) tutorial 45 | 46 | ## Initializing with SQL 47 | 48 | You can also initialize the `data.db` database by passing the URL to a SQL file. The easiest way to do this is to create a [GitHub Gist](https://gist.github.com/). 49 | 50 | This [example SQL file](https://gist.githubusercontent.com/simonw/ac4e19920b4b360752ac0f3ce85ba238/raw/90d31cf93bf1d97bb496de78559798f849b17e85/demo.sql) creates a table and populates it with three records. It's hosted in [this Gist](https://gist.github.com/simonw/ac4e19920b4b360752ac0f3ce85ba238). 51 | 52 | https://gist.githubusercontent.com/simonw/ac4e19920b4b360752ac0f3ce85ba238/raw/90d31cf93bf1d97bb496de78559798f849b17e85/demo.sql 53 | 54 | You can paste this URL into the "Load SQL by URL" prompt, or you can pass it as the `?sql=` parameter [like this](https://lite.datasette.io/?sql=https%3A%2F%2Fgist.githubusercontent.com%2Fsimonw%2Fac4e19920b4b360752ac0f3ce85ba238%2Fraw%2F90d31cf93bf1d97bb496de78559798f849b17e85%2Fdemo.sql). 55 | 56 | SQL will be executed before any CSV imports, so you can use initial SQL to create a table and then use `?csv=` to import data into it. 57 | 58 | ## Installing plugins 59 | 60 | Datasette has a number of [plugins](https://datasette.io/plugins) that enable new features. 61 | 62 | You can install plugins into Datasette Lite by adding one or more `?install=name-of-plugin` parameters to the URL. 63 | 64 | Not all plugins are compatible with Datasette Lite at the moment, for example plugins that load their own JavaScript and CSS do not currently work, see [issue #8](https://github.com/simonw/datasette-lite/issues/8). 65 | 66 | Here's a list of plugins that have been tested with Datasette Lite, plus demo links to see them in action: 67 | 68 | - [datasette-packages](https://datasette.io/plugins/datasette-packages) - Show a list of currently installed Python packages - [demo](https://lite.datasette.io/?install=datasette-packages#/-/packages) 69 | - [datasette-dateutil](https://datasette.io/plugins/datasette-dateutil) - dateutil functions for Datasette - [demo](https://lite.datasette.io/?install=datasette-dateutil#/fixtures?sql=select%0A++dateutil_parse%28%2210+october+2020+3pm%22%29%2C%0A++dateutil_parse_fuzzy%28%22This+is+due+10+september%22%29%2C%0A++dateutil_parse%28%221%2F2%2F2020%22%29%2C%0A++dateutil_parse%28%222020-03-04%22%29%2C%0A++dateutil_parse_dayfirst%28%222020-03-04%22%29%3B) 70 | - [datasette-schema-versions](https://datasette.io/plugins/datasette-schema-versions) - Datasette plugin that shows the schema version of every attached database - [demo](https://lite.datasette.io/?install=datasette-schema-versions#/-/schema-versions) 71 | - [datasette-debug-asgi](https://datasette.io/plugins/datasette-debug-asgi) - Datasette plugin for dumping out the ASGI scope. - [demo](https://lite.datasette.io/?install=datasette-debug-asgi#/-/asgi-scope) 72 | - [datasette-query-links](https://datasette.io/plugins/datasette-query-links) - Turn SELECT queries returned by a query into links to execute them - [demo](https://lite.datasette.io/?install=datasette-query-links#/fixtures?sql=select%0D%0A++'select+*+from+[facetable]'+as+query%0D%0Aunion%0D%0Aselect%0D%0A++'select+sqlite_version()'%0D%0Aunion%0D%0Aselect%0D%0A++'select+this+is+invalid+SQL+so+will+not+be+linked') 73 | - [datasette-json-html](https://datasette.io/plugins/datasette-json-html) - Datasette plugin for rendering HTML based on JSON values - [demo](https://lite.datasette.io/?install=datasette-json-html#/fixtures?sql=select+%27%5B%0A++++%7B%0A++++++++%22href%22%3A+%22https%3A%2F%2Fsimonwillison.net%2F%22%2C%0A++++++++%22label%22%3A+%22Simon+Willison%22%0A++++%7D%2C%0A++++%7B%0A++++++++%22href%22%3A+%22https%3A%2F%2Fgithub.com%2Fsimonw%2Fdatasette%22%2C%0A++++++++%22label%22%3A+%22Datasette%22%0A++++%7D%0A%5D%27+as+output) 74 | - [datasette-haversine](https://datasette.io/plugins/datasette-haversine) - Datasette plugin that adds a custom SQL function for haversine distances - [demo](https://lite.datasette.io/?install=datasette-haversine#/fixtures?sql=select+haversine%280%2C+154%2C+1%2C+131%29) 75 | - [datasette-jellyfish](https://datasette.io/plugins/datasette-jellyfish) - Datasette plugin that adds custom SQL functions for fuzzy string matching, built on top of the Jellyfish Python library - [demo](https://lite.datasette.io/?install=datasette-jellyfish#/fixtures?sql=SELECT%0A++++levenshtein_distance%28%3As1%2C+%3As2%29%2C%0A++++damerau_levenshtein_distance%28%3As1%2C+%3As2%29%2C%0A++++hamming_distance%28%3As1%2C+%3As2%29%2C%0A++++jaro_similarity%28%3As1%2C+%3As2%29%2C%0A++++jaro_winkler_similarity%28%3As1%2C+%3As2%29%2C%0A++++match_rating_comparison%28%3As1%2C+%3As2%29%3B&s1=barrack+obama&s2=barrack+h+obama) 76 | - [datasette-pretty-json](https://datasette.io/plugins/datasette-pretty-json) - Datasette plugin that pretty-prints any column values that are valid JSON objects or arrays. - [demo](https://lite.datasette.io/?install=datasette-pretty-json#/fixtures?sql=select+%27%7B%22this%22%3A+%5B%22is%22%2C+%22nested%22%2C+%22json%22%5D%7D%27) 77 | - [datasette-yaml](https://datasette.io/plugins/datasette-yaml) - Export Datasette records as YAML - [demo](https://lite.datasette.io/?install=datasette-yaml#/fixtures/compound_three_primary_keys.yaml) 78 | - [datasette-copyable](https://datasette.io/plugins/datasette-copyable) - Datasette plugin for outputting tables in formats suitable for copy and paste - [demo](https://lite.datasette.io/?install=datasette-copyable#/fixtures/compound_three_primary_keys.copyable?_table_format=github) 79 | - [datasette-mp3-audio](https://datasette.io/plugins/datasette-mp3-audio) - Turn `.mp3` URLs into an audio player in the Datasette interface - [demo](https://lite.datasette.io/?install=datasette-mp3-audio&csv=https://gist.githubusercontent.com/simonw/0a30d52feeb3ff60f7d8636b0bde296b/raw/c078a9e5a0151331e2e46c04c1ebe7edc9f45e8c/scotrail-announcements.csv#/data/scotrail-announcements) 80 | - [datasette-multiline-links](https://datasette.io/plugins/datasette-multiline-links) - Make multiple newline separated URLs clickable in Datasette - [demo](https://lite.datasette.io/?install=datasette-multiline-links&csv=https://docs.google.com/spreadsheets/d/1wZhPLMCHKJvwOkP4juclhjFgqIY8fQFMemwKL2c64vk/export?format=csv#/data?sql=select+edition%2C+headline%2C+text%2C+links%2C+hattips+from+export+where%0Atext+like+'%25'+||+%3Aq+||+'%25'+or+headline+like+'%25'+||+%3Aq+||+'%25'+order+by+edition+desc&q=loans) 81 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Datasette 5 | 6 | 33 | 34 | 35 | 36 | 37 | 38 |
39 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 |
93 | 94 | 152 | 153 |
154 | 155 |
156 |

157 | 158 | 159 | 160 | Documentation 161 |

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