Django integration for Frontend Bundlers & React
Project description
Alliance Platform Django Frontend
A library for integrating the Alliance Platform React library into a Django project.
Uses Vite to bundle Javascript and perform server-side rendering, and supplies a number of templatetags to easily embed Alliance Platform React components into Django templates.
Installation
pip install alliance-platform-frontend
System Requirements
- Supports django 4.2 and 5.0
- Python >=3.11
Usage
Alliance UI
A collection of built-in template tags for easily using Alliance UI React components in Django templates.
A templatetag (for example, Button) can be inserted in a template using the syntax:
{% Button variant="outlined" type="submit" %}Submit{% endButton %}
Components can be nested, e.g.
{% MenuBar %}
{% Menubar.SubMenu %}
{% Menubar.Item %}Item{% endMenubar.Item %}
{% endMenubar.SubMenu %}
{% endMenuBar %}
Keyword arguments to the tag will be automatically passed as props to the React component.
Available Tags
- Button
- ButtonGroup
- DatePicker
- Icon
- InlineAlert
- Menubar
- Menubar.SubMenu
- Menubar.Item
- Menubar.Section
- Pagination
- Table
- TableHeader
- TableBody
- ColumnHeaderLink
- Column
- Row
- Cell
- TimeInput
- Fragment
- raw_html
The following functions are also available:
utils.get_module_import_source
Given the name of the export within alliance-platform-js/ui
, creates the javascript import specification for the specified component.
Bundler
Templates
Template Tags
Release Process
Poetry Config
- Add test repository
poetry config repositories.testpypi https://test.pypi.org/legacy/
- Generate an account API token at https://test.pypi.org/manage/account/token/
poetry config pypi-token.testpypi ${TOKEN}
- On macs this will be stored in the
login
keychain atpoetry-repository-testpypi
- On macs this will be stored in the
- Main pypi repository
- Generate an account API token at https://pypi.org/manage/account/token/
poetry config pypi-token.pypi ${TOKEN}
- On macs this will be stored in the
login
keychain atpoetry-repository-pypi
- On macs this will be stored in the
Publishing a New Release
- Update CHANGELOG.md with details of changes and new version
- Run
bin/build.py
. This will extract version from CHANGELOG.md, bump version inpyproject.toml
and generate a build for publishing - Tag with new version and update the version branch:
ver=$( poetry version --short ) && echo "Version: $ver"
git tag v/frontend/$ver
git push --tags
- To publish to test.pypi.org
poetry publish --repository testpypi
- To publish to pypi.org
poetry publish
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for alliance_platform_frontend-0.0.12.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25d8943b1c8cf15ec6138ccd309ee75cf9a09607ad254dd63e60a1642f87d5a5 |
|
MD5 | cc41c3f4dfbecc08a5f76a176a3d1ad0 |
|
BLAKE2b-256 | ead14a9128c2104d108ee678a53326c509f19c2e35593b0a8a1e2c0b11cd0db1 |
Hashes for alliance_platform_frontend-0.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 59964f337c000f52ced84bb31ae2bec07660e501f6df3077db3bc373e0df51a7 |
|
MD5 | 332ca76bc0b1d00cc8c8b5e1ce37b71c |
|
BLAKE2b-256 | d6da839ed72b33cd067a55a686b7794081c095eb476d88248ee6e3abc8bf5892 |