yaakovLowenstein/hx-requests

A package to facilitate the use of HTMX with Django

django
htmx

hx-requests

Full documentation: https://hx-requests.readthedocs.io/en/latest/#


pre-commit Code style: ruff Code style: djlint

Hx-requests is a package to simplify the usage of htmx with Django. It enables an application to make asyncronous requests without clogging up views and urls with extra code. It simplifies making django forms post asyncronously with htmx, and many other awesome features.

The idea of hx-requests is that HXRequests absorb all htmx requests. Define an HXRequest and observe the magic of hx-requests.

  • No need to define extra urls to handle these requests
  • No need to add anything extra in views
  • Reusable HXRequests across views
  • Built in HXRequests to reduce boilerplate code

See full documentation here: https://hx-requests.readthedocs.io/en/latest/#

Installation

pip install hx-requests

python INSTALLED_APPS = ( ... 'hx_requests', )

Note It's assumed that htmx is already included in the base html file. It's also recommended to include hyperscript. Htmx: <script src="https://unpkg.com/[email protected]"></script>
Hyperscript: <script src="https://unpkg.com/[email protected]"></script>

Contributing to this repository

Getting setup

  • This project is using poetry
  • pre-commit is used for CI (code formatting, linting, etc...)
  • There is a dev container that can be used with vs-code

Committing

Must follow Conventional Commit https://www.conventionalcommits.org/en/v1.0.0/

Stars
47
100.00% more than last month
Forks
1
Open Issues
3