├── tests ├── test_project │ ├── __init__.py │ ├── urls.py │ └── settings.py └── test_django_http_debug.py ├── django_http_debug ├── migrations │ ├── __init__.py │ ├── 0004_debugendpoint_logging_enabled.py │ ├── 0003_requestlog_query_string.py │ ├── 0002_debugendpoint_content_type_debugendpoint_is_base64.py │ └── 0001_initial.py ├── __init__.py ├── middleware.py ├── views.py ├── models.py └── admin.py ├── .gitignore ├── .github └── workflows │ ├── test.yml │ └── publish.yml ├── pyproject.toml ├── README.md └── LICENSE /tests/test_project/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /django_http_debug/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /django_http_debug/__init__.py: -------------------------------------------------------------------------------- 1 | def example_function(): 2 | return 1 + 1 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | dist 11 | build 12 | -------------------------------------------------------------------------------- /tests/test_project/urls.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.urls import path 3 | 4 | urlpatterns = [ 5 | path("admin/", admin.site.urls), 6 | ] 7 | -------------------------------------------------------------------------------- /django_http_debug/middleware.py: -------------------------------------------------------------------------------- 1 | from .views import debug_view 2 | 3 | 4 | class DebugMiddleware: 5 | def __init__(self, get_response): 6 | self.get_response = get_response 7 | 8 | def __call__(self, request): 9 | response = self.get_response(request) 10 | if response.status_code == 404: 11 | path = request.path.lstrip("/") 12 | debug_response = debug_view(request, path) 13 | if debug_response: 14 | return debug_response 15 | return response 16 | -------------------------------------------------------------------------------- /django_http_debug/migrations/0004_debugendpoint_logging_enabled.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 5.0.3 on 2024-08-07 20:11 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | dependencies = [ 8 | ("django_http_debug", "0003_requestlog_query_string"), 9 | ] 10 | 11 | operations = [ 12 | migrations.AddField( 13 | model_name="debugendpoint", 14 | name="logging_enabled", 15 | field=models.BooleanField(default=True), 16 | ), 17 | ] 18 | -------------------------------------------------------------------------------- /django_http_debug/migrations/0003_requestlog_query_string.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 5.0.3 on 2024-08-07 20:05 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | dependencies = [ 8 | ( 9 | "django_http_debug", 10 | "0002_debugendpoint_content_type_debugendpoint_is_base64", 11 | ), 12 | ] 13 | 14 | operations = [ 15 | migrations.AddField( 16 | model_name="requestlog", 17 | name="query_string", 18 | field=models.CharField(blank=True, max_length=255), 19 | ), 20 | ] 21 | -------------------------------------------------------------------------------- /tests/test_project/settings.py: -------------------------------------------------------------------------------- 1 | SECRET_KEY = "django-insecure-test-key" 2 | DEBUG = True 3 | ALLOWED_HOSTS = ["*"] 4 | 5 | INSTALLED_APPS = [ 6 | "django.contrib.admin", 7 | "django.contrib.auth", 8 | "django.contrib.contenttypes", 9 | # "django.contrib.sessions", 10 | # "django.contrib.messages", 11 | # "django.contrib.staticfiles", 12 | "django_http_debug", 13 | ] 14 | 15 | MIDDLEWARE = [ 16 | "django_http_debug.middleware.DebugMiddleware", 17 | ] 18 | 19 | ROOT_URLCONF = "tests.test_project.urls" 20 | 21 | DATABASES = { 22 | "default": { 23 | "ENGINE": "django.db.backends.sqlite3", 24 | "NAME": ":memory:", 25 | } 26 | } 27 | 28 | USE_TZ = True 29 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | test: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Set up Python ${{ matrix.python-version }} 17 | uses: actions/setup-python@v5 18 | with: 19 | python-version: ${{ matrix.python-version }} 20 | cache: pip 21 | cache-dependency-path: pyproject.toml 22 | - name: Install dependencies 23 | run: | 24 | pip install '.[test]' 25 | - name: Run tests 26 | run: | 27 | pytest 28 | 29 | -------------------------------------------------------------------------------- /django_http_debug/migrations/0002_debugendpoint_content_type_debugendpoint_is_base64.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 5.0.3 on 2024-08-07 19:46 2 | 3 | from django.db import migrations, models 4 | 5 | 6 | class Migration(migrations.Migration): 7 | dependencies = [ 8 | ("django_http_debug", "0001_initial"), 9 | ] 10 | 11 | operations = [ 12 | migrations.AddField( 13 | model_name="debugendpoint", 14 | name="content_type", 15 | field=models.CharField(default="text/plain; charset=utf-8", max_length=64), 16 | ), 17 | migrations.AddField( 18 | model_name="debugendpoint", 19 | name="is_base64", 20 | field=models.BooleanField(default=False), 21 | ), 22 | ] 23 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "django-http-debug" 3 | version = "0.2" 4 | description = "Django app for creating database-backed HTTP debug endpoints" 5 | readme = "README.md" 6 | requires-python = ">=3.8" 7 | authors = [{name = "Simon Willison"}] 8 | license = {text = "Apache-2.0"} 9 | classifiers = [ 10 | "License :: OSI Approved :: Apache Software License" 11 | ] 12 | dependencies = [ 13 | "filetype", 14 | "django" 15 | ] 16 | 17 | [build-system] 18 | requires = ["setuptools"] 19 | build-backend = "setuptools.build_meta" 20 | 21 | [project.urls] 22 | Homepage = "https://github.com/simonw/django-http-debug" 23 | Changelog = "https://github.com/simonw/django-http-debug/releases" 24 | Issues = "https://github.com/simonw/django-http-debug/issues" 25 | CI = "https://github.com/simonw/django-http-debug/actions" 26 | 27 | 28 | [project.optional-dependencies] 29 | test = ["pytest", "pytest-django"] 30 | 31 | [tool.pytest.ini_options] 32 | DJANGO_SETTINGS_MODULE = "tests.test_project.settings" 33 | pythonpath = ["."] 34 | -------------------------------------------------------------------------------- /django_http_debug/views.py: -------------------------------------------------------------------------------- 1 | import base64 2 | from django.http import HttpResponse 3 | from django.views.decorators.csrf import csrf_exempt 4 | from .models import DebugEndpoint, RequestLog 5 | 6 | 7 | @csrf_exempt 8 | def debug_view(request, path): 9 | try: 10 | endpoint = DebugEndpoint.objects.get(path=path) 11 | except DebugEndpoint.DoesNotExist: 12 | return None # Allow normal 404 handling to continue 13 | 14 | if endpoint.logging_enabled: 15 | log_entry = RequestLog( 16 | endpoint=endpoint, 17 | method=request.method, 18 | query_string=request.META.get("QUERY_STRING", ""), 19 | headers=dict(request.headers), 20 | ) 21 | log_entry.set_body(request.body) 22 | log_entry.save() 23 | 24 | content = endpoint.content 25 | if endpoint.is_base64: 26 | content = base64.b64decode(content) 27 | 28 | response = HttpResponse( 29 | content=content, 30 | status=endpoint.status_code, 31 | content_type=endpoint.content_type, 32 | ) 33 | for key, value in endpoint.headers.items(): 34 | response[key] = value 35 | 36 | return response 37 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | cache: pip 23 | cache-dependency-path: pyproject.toml 24 | - name: Install dependencies 25 | run: | 26 | pip install '.[test]' 27 | - name: Run tests 28 | run: | 29 | pytest 30 | deploy: 31 | runs-on: ubuntu-latest 32 | needs: [test] 33 | environment: release 34 | permissions: 35 | id-token: write 36 | steps: 37 | - uses: actions/checkout@v4 38 | - name: Set up Python 39 | uses: actions/setup-python@v5 40 | with: 41 | python-version: "3.12" 42 | cache: pip 43 | cache-dependency-path: pyproject.toml 44 | - name: Install dependencies 45 | run: | 46 | pip install setuptools wheel build 47 | - name: Build 48 | run: | 49 | python -m build 50 | - name: Publish 51 | uses: pypa/gh-action-pypi-publish@release/v1 52 | 53 | -------------------------------------------------------------------------------- /django_http_debug/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | import base64 3 | 4 | 5 | class DebugEndpoint(models.Model): 6 | path = models.CharField(max_length=255, unique=True) 7 | status_code = models.IntegerField(default=200) 8 | content_type = models.CharField(max_length=64, default="text/plain; charset=utf-8") 9 | headers = models.JSONField(default=dict, blank=True) 10 | content = models.TextField(blank=True) 11 | is_base64 = models.BooleanField(default=False) 12 | logging_enabled = models.BooleanField(default=True) 13 | 14 | def __str__(self): 15 | return self.path 16 | 17 | def get_absolute_url(self): 18 | return f"/{self.path}" 19 | 20 | 21 | class RequestLog(models.Model): 22 | endpoint = models.ForeignKey(DebugEndpoint, on_delete=models.CASCADE) 23 | method = models.CharField(max_length=10) 24 | query_string = models.CharField(max_length=255, blank=True) 25 | headers = models.JSONField() 26 | body = models.TextField(blank=True) 27 | is_base64 = models.BooleanField(default=False) 28 | timestamp = models.DateTimeField(auto_now_add=True) 29 | 30 | def __str__(self): 31 | return f"{self.method} {self.endpoint.path} at {self.timestamp}" 32 | 33 | def set_body(self, body): 34 | try: 35 | # Try to decode as UTF-8 36 | self.body = body.decode("utf-8") 37 | self.is_base64 = False 38 | except UnicodeDecodeError: 39 | # If that fails, store as base64 40 | self.body = base64.b64encode(body).decode("ascii") 41 | self.is_base64 = True 42 | 43 | def get_body(self): 44 | if self.is_base64: 45 | return base64.b64decode(self.body.encode("ascii")) 46 | return self.body 47 | -------------------------------------------------------------------------------- /django_http_debug/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # Generated by Django 5.0.2 on 2024-08-07 18:12 2 | 3 | import django.db.models.deletion 4 | from django.db import migrations, models 5 | 6 | 7 | class Migration(migrations.Migration): 8 | initial = True 9 | 10 | dependencies = [] 11 | 12 | operations = [ 13 | migrations.CreateModel( 14 | name="DebugEndpoint", 15 | fields=[ 16 | ( 17 | "id", 18 | models.AutoField( 19 | auto_created=True, 20 | primary_key=True, 21 | serialize=False, 22 | verbose_name="ID", 23 | ), 24 | ), 25 | ("path", models.CharField(max_length=255, unique=True)), 26 | ("status_code", models.IntegerField(default=200)), 27 | ("headers", models.JSONField(blank=True, default=dict)), 28 | ("content", models.TextField(blank=True)), 29 | ], 30 | ), 31 | migrations.CreateModel( 32 | name="RequestLog", 33 | fields=[ 34 | ( 35 | "id", 36 | models.AutoField( 37 | auto_created=True, 38 | primary_key=True, 39 | serialize=False, 40 | verbose_name="ID", 41 | ), 42 | ), 43 | ("method", models.CharField(max_length=10)), 44 | ("headers", models.JSONField()), 45 | ("body", models.TextField(blank=True)), 46 | ("is_base64", models.BooleanField(default=False)), 47 | ("timestamp", models.DateTimeField(auto_now_add=True)), 48 | ( 49 | "endpoint", 50 | models.ForeignKey( 51 | on_delete=django.db.models.deletion.CASCADE, 52 | to="django_http_debug.debugendpoint", 53 | ), 54 | ), 55 | ], 56 | ), 57 | ] 58 | -------------------------------------------------------------------------------- /tests/test_django_http_debug.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | from django_http_debug.models import DebugEndpoint, RequestLog 3 | from django.test.client import Client 4 | 5 | 6 | @pytest.mark.django_db 7 | def test_debug_view(): 8 | assert Client().get("/test/endpoint").status_code == 404 9 | DebugEndpoint.objects.create( 10 | path="test/endpoint", 11 | status_code=200, 12 | content="Test content", 13 | content_type="text/plain", 14 | ) 15 | response = Client().get("/test/endpoint") 16 | assert response.status_code == 200 17 | assert response.content == b"Test content" 18 | assert response["Content-Type"] == "text/plain" 19 | 20 | 21 | @pytest.mark.django_db 22 | def test_request_logging(): 23 | endpoint = DebugEndpoint.objects.create( 24 | path="test/log", 25 | status_code=200, 26 | content="Log test", 27 | ) 28 | assert endpoint.requestlog_set.count() == 0 29 | 30 | Client().get("/test/log?param=value") 31 | 32 | log = RequestLog.objects.filter(endpoint=endpoint).first() 33 | assert log is not None 34 | assert log.method == "GET" 35 | assert log.query_string == "param=value" 36 | 37 | 38 | @pytest.mark.django_db 39 | def test_logging_disabled(): 40 | DebugEndpoint.objects.create( 41 | path="test/nolog", 42 | status_code=200, 43 | content="No log test", 44 | logging_enabled=False, 45 | ) 46 | 47 | assert Client().get("/test/nolog").status_code == 200 48 | 49 | assert RequestLog.objects.count() == 0 50 | 51 | 52 | @pytest.mark.django_db 53 | def test_base64_content(): 54 | import base64 55 | 56 | content = base64.b64encode(b"Binary content").decode() 57 | DebugEndpoint.objects.create( 58 | path="test/binary", 59 | status_code=200, 60 | content=content, 61 | is_base64=True, 62 | content_type="application/octet-stream", 63 | ) 64 | 65 | response = Client().get("/test/binary") 66 | assert response.status_code == 200 67 | assert response.content == b"Binary content" 68 | assert response["Content-Type"] == "application/octet-stream" 69 | 70 | 71 | @pytest.mark.django_db 72 | def test_custom_headers(): 73 | DebugEndpoint.objects.create( 74 | path="test/headers", 75 | status_code=200, 76 | content="Custom headers test", 77 | headers={"X-Custom-Header": "Test Value"}, 78 | ) 79 | 80 | response = Client().get("/test/headers") 81 | assert response.status_code == 200 82 | assert response["X-Custom-Header"] == "Test Value" 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-http-debug 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/django-http-debug.svg)](https://pypi.org/project/django-http-debug/) 4 | [![Tests](https://github.com/simonw/django-http-debug/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/django-http-debug/actions/workflows/test.yml) 5 | [![Changelog](https://img.shields.io/github/v/release/simonw/django-http-debug?include_prereleases&label=changelog)](https://github.com/simonw/django-http-debug/releases) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/django-http-debug/blob/main/LICENSE) 7 | 8 | Django app for creating database-backed HTTP debug endpoints 9 | 10 | Background on this project: [django-http-debug, a new Django app mostly written by Claude](https://simonwillison.net/2024/Aug/8/django-http-debug/) 11 | 12 | ## Installation 13 | 14 | Install this library using `pip`: 15 | ```bash 16 | pip install django-http-debug 17 | ``` 18 | ## Configuration 19 | 20 | Once installed in the same environment as your Django application, add the following to `INSTALLED_APPS` in your Django settings: 21 | ```python 22 | INSTALLED_APPS = [ 23 | # ... 24 | 'django_http_debug', 25 | # ... 26 | ] 27 | ``` 28 | And add this to `MIDDLEWARE`: 29 | ```python 30 | MIDDLEWARE = [ 31 | # ... 32 | "django_http_debug.middleware.DebugMiddleware", 33 | # ... 34 | ] 35 | ``` 36 | Then run `./manage.py migrate` to create the necessary database tables. 37 | 38 | ## Usage 39 | 40 | You can configure new endpoints in the Django admin. These will only work if they are for URLs that are not yet being served by the rest of your application. 41 | 42 | Give an endpoint a path (starting without a `/`) such as: 43 | 44 | webhooks/debug/ 45 | 46 | You can optionally configure the returned body or HTTP headers here too. 47 | 48 | If you want to return a binary body - a GIF for example - you can set that endpoint to use Base64 encoding and then paste a base64-encoded string into the body field. 49 | 50 | On macOS you can create base64 strings like this: 51 | ```bash 52 | base64 -i pixel.gif -o - 53 | ``` 54 | Any HTTP requests made to `/webhooks/debug/` will be logged in the database. You can view these requests in the Django admin. 55 | 56 | You can turn off the "Logging enabled" option on an endpoint to stop logging requests to it to the database. 57 | 58 | ## Development 59 | 60 | To contribute to this library, first checkout the code. Then create a new virtual environment: 61 | ```bash 62 | cd django-http-debug 63 | python -m venv venv 64 | source venv/bin/activate 65 | ``` 66 | Now install the dependencies and test dependencies: 67 | ```bash 68 | pip install -e '.[test]' 69 | ``` 70 | To run the tests: 71 | ```bash 72 | pytest 73 | ``` 74 | -------------------------------------------------------------------------------- /django_http_debug/admin.py: -------------------------------------------------------------------------------- 1 | import re 2 | import filetype 3 | from django.contrib import admin 4 | from django.utils.html import format_html 5 | from django.utils.safestring import mark_safe 6 | from .models import DebugEndpoint, RequestLog 7 | 8 | sequence_re = re.compile(r"((?:\\x[0-9a-f]{2})+)") 9 | octet_re = re.compile(r"(\\x[0-9a-f]{2})") 10 | 11 | QUERY_STRING_TRUNCATE = 16 12 | 13 | 14 | @admin.register(DebugEndpoint) 15 | class DebugEndpointAdmin(admin.ModelAdmin): 16 | list_display = ("path", "status_code", "logging_enabled") 17 | list_filter = ("logging_enabled",) 18 | 19 | 20 | @admin.register(RequestLog) 21 | class RequestLogAdmin(admin.ModelAdmin): 22 | list_display = ( 23 | "timestamp", 24 | "endpoint", 25 | "method", 26 | "query_string_truncated", 27 | "body_preview", 28 | "is_base64", 29 | ) 30 | list_filter = ("endpoint", "method", "is_base64") 31 | readonly_fields = ( 32 | "endpoint", 33 | "query_string", 34 | "method", 35 | "headers", 36 | "body", 37 | "body_display", 38 | "is_base64", 39 | "timestamp", 40 | ) 41 | 42 | def has_add_permission(self, request): 43 | return False 44 | 45 | def has_change_permission(self, request, obj=None): 46 | return False 47 | 48 | def query_string_truncated(self, obj): 49 | return obj.query_string[:QUERY_STRING_TRUNCATE] + ( 50 | "…" if len(obj.query_string) > QUERY_STRING_TRUNCATE else "" 51 | ) 52 | 53 | query_string_truncated.short_description = "Query string" 54 | 55 | def body_preview(self, obj): 56 | body = obj.get_body() 57 | if isinstance(body, bytes): 58 | return f"Binary data ({len(body)} bytes)" 59 | return body[:50] + ("..." if len(body) > 50 else "") 60 | 61 | body_preview.short_description = "Body preview" 62 | 63 | def body_display(self, obj): 64 | body = obj.get_body() 65 | if not isinstance(body, bytes): 66 | return format_html("
{}
", body) 67 | 68 | # Attempt to guess filetype 69 | suggestion = None 70 | match = filetype.guess(body[:1000]) 71 | if match: 72 | suggestion = "{} ({})".format(match.extension, match.mime) 73 | 74 | encoded = repr(body) 75 | # Ditch the b' and trailing ' 76 | if encoded.startswith("b'") and encoded.endswith("'"): 77 | encoded = encoded[2:-1] 78 | 79 | # Split it into sequences of octets and characters 80 | chunks = sequence_re.split(encoded) 81 | html = [] 82 | if suggestion: 83 | html.append( 84 | '

Suggestion: {}

'.format( 85 | suggestion 86 | ) 87 | ) 88 | for chunk in chunks: 89 | if sequence_re.match(chunk): 90 | octets = octet_re.findall(chunk) 91 | octets = [o[2:] for o in octets] 92 | html.append( 93 | '{}'.format( 94 | " ".join(octets).upper() 95 | ) 96 | ) 97 | else: 98 | html.append(chunk.replace("\\\\", "\\")) 99 | 100 | return mark_safe(" ".join(html).strip().replace("\\r\\n", "
")) 101 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------