Skip to content

v3.6.0 #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Using the following categories, list your changes in this order:

## [Unreleased]

- Nothing (yet)!

## [3.6.0] - 2024-01-10

### Added

- Built-in Single Page Application (SPA) support!
Expand Down Expand Up @@ -213,7 +217,7 @@ Using the following categories, list your changes in this order:

### Changed

- `django-reactpy` database entries are no longer cleaned during Django application startup. Instead, it will occur on webpage loads if `REACTPY_RECONNECT_MAX` seconds has elapsed since the last cleaning.
- `reactpy-django` database entries are no longer cleaned during Django application startup. Instead, it will occur on webpage loads if `REACTPY_RECONNECT_MAX` seconds has elapsed since the last cleaning.

## [3.0.0-reactpy] - 2023-03-30

Expand Down Expand Up @@ -433,7 +437,8 @@ Using the following categories, list your changes in this order:

- Support for IDOM within the Django

[unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.5.1...HEAD
[unreleased]: https://github.com/reactive-python/reactpy-django/compare/3.6.0...HEAD
[3.6.0]: https://github.com/reactive-python/reactpy-django/compare/3.5.1...3.6.0
[3.5.1]: https://github.com/reactive-python/reactpy-django/compare/3.5.0...3.5.1
[3.5.0]: https://github.com/reactive-python/reactpy-django/compare/3.4.0...3.5.0
[3.4.0]: https://github.com/reactive-python/reactpy-django/compare/3.3.2...3.4.0
Expand Down
4 changes: 2 additions & 2 deletions docs/src/about/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ git clone https://github.com/reactive-python/reactpy-django.git
cd reactpy-django
```

Then, by running the command below you can install the dependencies needed to run the ReactPy Django development environment.
Then, by running the command below you can install the dependencies needed to run the ReactPy-Django development environment.

```bash linenums="0"
pip install -r requirements.txt --upgrade --verbose
Expand All @@ -38,7 +38,7 @@ pip install -r requirements.txt --upgrade --verbose

Some of our development dependencies require a C++ compiler, which is not installed by default on Windows. If you receive errors related to this during installation, follow the instructions in your console errors.

Additionally, be aware that ReactPy Django's JavaScript bundle is built within the following scenarios:
Additionally, be aware that ReactPy-Django's JavaScript bundle is built within the following scenarios:

1. When `pip install` is run on the `reactpy-django` package.
2. Every time `python manage.py ...` or `nox ...` is run
Expand Down
16 changes: 8 additions & 8 deletions docs/src/reference/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Prefabricated hooks can be used within your `components.py` to help simplify dev

---

### `#!python use_query(query, *args, **kwargs)`
### Use Query

Execute functions in the background and return the result, typically to [read](https://www.sumologic.com/glossary/crud/) data from the Django ORM.

Expand Down Expand Up @@ -164,7 +164,7 @@ Query functions can be sync or async.

---

### `#!python use_mutation(mutation, refetch=None)`
### Use Mutation

Modify data in the background, typically to [create/update/delete](https://www.sumologic.com/glossary/crud/) data from the Django ORM.

Expand Down Expand Up @@ -273,7 +273,7 @@ Mutation functions can be sync or async.

---

### `#!python use_user_data(default_data=None, save_default_data=False)`
### Use User Data

Store or retrieve data (`#!python dict`) specific to the connection's `#!python User`. This data is stored in the `#!python REACTPY_DATABASE`.

Expand Down Expand Up @@ -316,7 +316,7 @@ Store or retrieve data (`#!python dict`) specific to the connection's `#!python

---

### `#!python use_connection()`
### Use Connection

Returns the active connection, which is either a Django [WebSocket](https://channels.readthedocs.io/en/stable/topics/consumers.html#asyncjsonwebsocketconsumer) or a [HTTP Request](https://docs.djangoproject.com/en/4.2/ref/request-response/#django.http.HttpRequest).

Expand All @@ -340,7 +340,7 @@ Returns the active connection, which is either a Django [WebSocket](https://chan

---

### `#!python use_scope()`
### Use Scope

Shortcut that returns the WebSocket or HTTP connection's [scope](https://channels.readthedocs.io/en/stable/topics/consumers.html#scope).

Expand All @@ -364,7 +364,7 @@ Shortcut that returns the WebSocket or HTTP connection's [scope](https://channel

---

### `#!python use_location()`
### Use Location

Shortcut that returns the browser's current `#!python Location`.

Expand All @@ -386,7 +386,7 @@ Shortcut that returns the browser's current `#!python Location`.
| --- | --- |
| `#!python Location` | An object containing the current URL's `#!python pathname` and `#!python search` query. |

### `#!python use_origin()`
### Use Origin

Shortcut that returns the WebSocket or HTTP connection's `#!python origin`.

Expand All @@ -412,7 +412,7 @@ You can expect this hook to provide strings such as `http://example.com`.

---

### `#!python use_user()`
### Use User

Shortcut that returns the WebSocket or HTTP connection's `#!python User`.

Expand Down
4 changes: 3 additions & 1 deletion docs/src/reference/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ A variant of [`reactpy-router`](https://github.com/reactive-python/reactpy-route

---

## `#!python django_router(*routes)`
## Django Router

URL router that enables the ability to conditionally render other components based on the client's current URL `#!python path`.

=== "components.py"

Expand Down
2 changes: 1 addition & 1 deletion src/reactpy_django/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
REACTPY_WEBSOCKET_ROUTE,
)

__version__ = "3.5.1"
__version__ = "3.6.0"
__all__ = [
"REACTPY_WEBSOCKET_PATH",
"REACTPY_WEBSOCKET_ROUTE",
Expand Down
2 changes: 1 addition & 1 deletion tests/test_app/settings_multi_db.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,5 +155,5 @@
},
}

# ReactPy Django Settings
# ReactPy-Django Settings
REACTPY_BACKHAUL_THREAD = "test" not in sys.argv and "runserver" not in sys.argv
2 changes: 1 addition & 1 deletion tests/test_app/settings_single_db.py
Original file line number Diff line number Diff line change
Expand Up @@ -136,5 +136,5 @@
},
}

# ReactPy Django Settings
# ReactPy-Django Settings
REACTPY_BACKHAUL_THREAD = "test" not in sys.argv and "runserver" not in sys.argv