View to Component

CHANGELOG.md

@@ -24,9 +24,14 @@ Using the following categories, list your changes in this order:
 
 ### Added
 
--   `auth_required` decorator to prevent your components from rendered to unauthenticated users.
+-   `auth_required` decorator to prevent your components from rendering to unauthenticated users.
 -   `use_query` hook for fetching database values.
 -   `use_mutation` hook for modifying database values.
+-   `view_to_component` utility to convert legacy Django views to IDOM components.
+
+### Changed
+
+-   Bumped the minimum IDOM version to 0.40.2
 
 ### Fixed
 

docs/includes/examples.md

@@ -0,0 +1,23 @@
+<!--hello-world-view-start-->
+
+```python
+from django.http import HttpResponse
+
+def hello_world_view(request, *args, **kwargs):
+    return HttpResponse("Hello World!")
+```
+
+<!--hello-world-view-end-->
+
+<!--hello-world-cbv-start-->
+
+```python
+from django.http import HttpResponse
+from django.views import View
+
+class HelloWorldView(View):
+    def get(self, request, *args, **kwargs):
+        return HttpResponse("Hello World!")
+```
+
+<!--hello-world-cbv-end-->

docs/src/changelog/index.md

@@ -0,0 +1,11 @@
+---
+hide:
+    - navigation
+    - toc
+---
+
+!!! note "Attribution"
+
+        {% include-markdown "../../../CHANGELOG.md" start="<!--attr-start-->" end="<!--attr-end-->" %}
+
+{% include-markdown "../../../CHANGELOG.md" start="<!--changelog-start-->" %}

docs/src/contribute/running-tests.md

@@ -0,0 +1,15 @@
+This repo uses [Nox](https://nox.thea.codes/en/stable/) to run scripts which can be found in `noxfile.py`. For a full test of available scripts run `nox -l`. To run the full test suite simple execute:
+
+```
+nox -s test
+```
+
+If you do not want to run the tests in the background:
+
+```
+nox -s test -- --headed
+```
+
+!!! warning "Most tests will not run on Windows"
+
+    Due to [bugs within Django Channels](https://github.com/django/channels/issues/1207), functional tests are not run on Windows. In order for Windows users to test Django-IDOM functionality, you will need to run tests via [Windows Subsystem for Linux](https://code.visualstudio.com/docs/remote/wsl).