# hx-requests
Full documentation: https://hx-requests.readthedocs.io/en/latest/#
<br>
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://www.djlint.com)
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
```python
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/htmx.org@1.8.6"></script>`
</br>
Hyperscript: `<script src="https://unpkg.com/hyperscript.org@0.9.8"></script>`
# Contributing to this repository
**Warning CI is not setup yet, but will be at a later date.**
## Getting setup
- This project is using poetry
- 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/
Raw data
{
"_id": null,
"home_page": "https://github.com/yaakovLowenstein/hx-requests",
"name": "hx-requests",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "django, htmx",
"author": "yaakovLowenstein",
"author_email": "lowensteinyaakov@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/cb/32/18b099177a471c7fa3ae23cb039c1da39b05d54c0642177a2952c847868f/hx_requests-0.28.1.tar.gz",
"platform": null,
"description": "# hx-requests\n\nFull documentation: https://hx-requests.readthedocs.io/en/latest/#\n\n<br>\n\n[](https://github.com/pre-commit/pre-commit)\n[](https://github.com/psf/black)\n[](https://pycqa.github.io/isort/)\n[](https://www.djlint.com)\n\nHx-requests is a package to simplify the usage of htmx with Django.\nIt enables an application to make asyncronous requests without clogging up\nviews and urls with extra code. It simplifies making django forms post asyncronously\nwith htmx, and many other awesome features.\n\nThe idea of hx-requests is that `HXRequests` absorb all htmx requests.\nDefine an `HXRequest` and\nobserve the magic of `hx-requests`.\n\n- No need to define extra urls to handle these requests\n- No need to add anything extra in views\n- Reusable `HXRequests` across views\n- Built in `HXRequests` to reduce boilerplate code\n\nSee full documentation here: https://hx-requests.readthedocs.io/en/latest/#\n\n# Installation\n\n```python\npip install hx-requests\n```\n\n```python\nINSTALLED_APPS = (\n ...\n 'hx_requests',\n)\n ```\n\n**Note**\nIt's assumed that htmx is already included in the base html file. It's also recommended to include hyperscript.\nHtmx: `<script src=\"https://unpkg.com/htmx.org@1.8.6\"></script>`\n</br>\nHyperscript: `<script src=\"https://unpkg.com/hyperscript.org@0.9.8\"></script>`\n\n# Contributing to this repository\n\n**Warning CI is not setup yet, but will be at a later date.**\n## Getting setup\n\n- This project is using poetry\n- There is a dev container that can be used with vs-code\n\n\n\n## Committing\n\nMust follow Conventional Commit\nhttps://www.conventionalcommits.org/en/v1.0.0/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Facilitates the usage of HTMX with Django",
"version": "0.28.1",
"project_urls": {
"Homepage": "https://github.com/yaakovLowenstein/hx-requests",
"Repository": "https://github.com/yaakovLowenstein/hx-requests"
},
"split_keywords": [
"django",
" htmx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b19f177c3cd16ac0056880c4269be33d6482f96143548a31e6407a2aec19437",
"md5": "09251ec3a972f156abfe6e63bce7f58a",
"sha256": "e708d54ef4f64c7837aadaa72a80609cb63b1d15d783998c32ad90fdf5b827a3"
},
"downloads": -1,
"filename": "hx_requests-0.28.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09251ec3a972f156abfe6e63bce7f58a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 15870,
"upload_time": "2024-05-15T16:52:22",
"upload_time_iso_8601": "2024-05-15T16:52:22.979146Z",
"url": "https://files.pythonhosted.org/packages/0b/19/f177c3cd16ac0056880c4269be33d6482f96143548a31e6407a2aec19437/hx_requests-0.28.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb3218b099177a471c7fa3ae23cb039c1da39b05d54c0642177a2952c847868f",
"md5": "a28a1ee2e2f75ee4b2f1d4ed75595dca",
"sha256": "c03d59560d3e6f88e03764d83e24b96579853255b0db5b146ccddf48cb5f536f"
},
"downloads": -1,
"filename": "hx_requests-0.28.1.tar.gz",
"has_sig": false,
"md5_digest": "a28a1ee2e2f75ee4b2f1d4ed75595dca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 13553,
"upload_time": "2024-05-15T16:52:25",
"upload_time_iso_8601": "2024-05-15T16:52:25.185254Z",
"url": "https://files.pythonhosted.org/packages/cb/32/18b099177a471c7fa3ae23cb039c1da39b05d54c0642177a2952c847868f/hx_requests-0.28.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-15 16:52:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yaakovLowenstein",
"github_project": "hx-requests",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hx-requests"
}
JSON
