v3.0.0a1: Bump IDOM to 1.0.0 pre-release (#125)

- Modify docs to use the upcoming IDOM-Core docs styling - Move docs python examples to individual files so we can run tests on them - CI for type checking + linting docs examples - Minor wording and section naming changes to feel more React-like - Bump IDOM to 1.0.0 pre-release - Use the new `idom.html` API - Update package.json to be compatible with `idom>=1.0.0` - Make the main `requirements.txt` be fully inclusive of all dev/user/docs dependencies to simplify development workflow - Update `setup.py` to automatically install the latest NPM, and be easier to debug when things fail

Author: Archmonger

.github/workflows/test-docs.yml

@@ -20,6 +20,16 @@ jobs:
  - uses: actions/setup-python@v4
  with:
  python-version: 3.x
- - run: pip install -r requirements/build-docs.txt
- - run: linkcheckMarkdown docs/ -v -r
- - run: mkdocs build --strict
+ - name: Check docs build
+ run: |
+ pip install -r requirements/build-docs.txt
+ linkcheckMarkdown docs/ -v -r
+ mkdocs build --strict
+ - name: Check docs examples
+ run: |
+ pip install -r requirements/check-types.txt
+ pip install -r requirements/check-style.txt
+ mypy --show-error-codes docs/python/
+ black docs/python/ --check
+ isort docs/python/ --check-only
+ flake8 docs/python/

.gitignore

@@ -38,6 +38,7 @@ settings.json
 *$py.class
 
 # Distribution / packaging
+build/
 .Python build/
 develop-eggs/
 dist/

CHANGELOG.md

@@ -10,30 +10,58 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 <!--
 Using the following categories, list your changes in this order:
- - "Added" for new features.
- - "Changed" for changes in existing functionality.
- - "Deprecated" for soon-to-be removed features.
- - "Removed" for now removed features.
- - "Fixed" for any bug fixes.
- - "Security" in case of vulnerabilities.
+
+### Added
+- for new features.
+
+### Changed
+- for changes in existing functionality.
+
+### Deprecated
+- for soon-to-be removed features.
+
+### Removed
+- for removed features.
+
+### Fixed
+- for bug fixes.
+
+### Security
+- for vulnerability fixes.
  -->
 
 <!--changelog-start-->
 
 ## [Unreleased]
 
+- Nothing (yet)
+
+## [3.0.0a1] - 2023-02-02
+
+???+ note
+
+ This is Django-IDOM's biggest update yet!
+
+ To upgrade from previous version you will need to...
+
+ 1. Install `django-idom >= 3.0.0`
+ 2. Run `idom update-html-usages <DIR>` to update your `idom.html.*` calls to the new syntax
+ 3. Run `python manage.py migrate` to create the new Django-IDOM database entries
+
 ### Added
 
 - The `idom` client will automatically configure itself to debug mode depending on `settings.py:DEBUG`.
 - `use_connection` hook for returning the browser's active `Connection`
 
 ### Changed
 
+- It is now mandatory to run `manage.py migrate` after installing IDOM.
+- Bumped the minimum IDOM version to 1.0.0
+ - Due to IDOM 1.0.0, `idom.html.*`, HTML properties are now `snake_case` `**kwargs` rather than a `dict` of values.
+ - You can auto-convert to the new style using `idom update-html-usages <DIR>`.
 - The `component` template tag now supports both positional and keyword arguments.
 - The `component` template tag now supports non-serializable arguments.
 - `IDOM_WS_MAX_RECONNECT_TIMEOUT` setting has been renamed to `IDOM_RECONNECT_MAX`.
-- It is now mandatory to run `manage.py migrate` after installing IDOM.
-- Bumped the minimum IDOM version to 0.43.0
 
 ### Removed
 
@@ -51,7 +79,7 @@ Using the following categories, list your changes in this order:
 - Fixed a potential method of component template tag argument spoofing.
 - Exception information will no longer be displayed on the page, based on the value of `settings.py:DEBUG`.
 
-## [2.2.1] - 2022-01-09
+## [2.2.1] - 2023-01-09
 
 ### Fixed
 
@@ -218,7 +246,8 @@ Using the following categories, list your changes in this order:
 
 - Support for IDOM within the Django
 
-[unreleased]: https://github.com/idom-team/django-idom/compare/2.2.1...HEAD
+[unreleased]: https://github.com/idom-team/django-idom/compare/3.0.0a1...HEAD
+[3.0.0a1]: https://github.com/idom-team/django-idom/compare/2.2.1...3.0.0a1
 [2.2.1]: https://github.com/idom-team/django-idom/compare/2.2.0...2.2.1
 [2.2.0]: https://github.com/idom-team/django-idom/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/idom-team/django-idom/compare/2.0.1...2.1.0

README.md

@@ -1,6 +1,6 @@
 <!--header-start-->
 
-# Django IDOM &middot; [![Tests](https://github.com/idom-team/django-idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/django-idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/django-idom.svg?label=PyPI)](https://pypi.python.org/pypi/django-idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/django-idom/blob/main/LICENSE) [![Docs](https://img.shields.io/website?down_message=offline&label=Docs&logo=read%20the%20docs&logoColor=white&up_message=online&url=https%3A%2F%2Fidom-team.github.io%2Fdjango-idom%2F)](https://idom-team.github.io/django-idom/)
+# Django-IDOM &middot; [![Tests](https://github.com/idom-team/django-idom/workflows/Test/badge.svg?event=push)](https://github.com/idom-team/django-idom/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/django-idom.svg?label=PyPI)](https://pypi.python.org/pypi/django-idom) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/idom-team/django-idom/blob/main/LICENSE) [![Docs](https://img.shields.io/website?down_message=offline&label=Docs&logo=read%20the%20docs&logoColor=white&up_message=online&url=https%3A%2F%2Fidom-team.github.io%2Fdjango-idom%2F)](https://idom-team.github.io/django-idom/)
 
 <!--header-end-->
 <!--intro-start-->

docs/includes/examples.md

@@ -0,0 +1,3 @@
+Now, you can create/modify the Django-IDOM source code, and Pull Request (PR) your changes to our GitHub repository.
+
+To learn how to create GitHub PRs, [click here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).

docs/includes/pr.md

@@ -0,0 +1,13 @@
+{% extends "base.html" %}
+
+{% block content %}
+{{ super() }}
+
+{% if git_page_authors %}
+<div class="md-source-date">
+ <small>
+ Authors: {{ git_page_authors | default('enable mkdocs-git-authors-plugin') }}
+ </small>
+</div>
+{% endif %}
+{% endblock %}

docs/overrides/main.html

@@ -0,0 +1,9 @@
+from idom import component, html
+
+from django_idom.decorators import auth_required
+
+
+@component
+@auth_required(auth_attribute="is_staff")
+def my_component():
+ return html.div("I am logged in!")

docs/python/__init__.py

@@ -0,0 +1,14 @@
+from idom import component, html
+
+from django_idom.decorators import auth_required
+
+
+@component
+def my_component_fallback():
+ return html.div("I am NOT logged in!")
+
+
+@component
+@auth_required(fallback=my_component_fallback)
+def my_component():
+ return html.div("I am logged in!")