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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c2e58c072538c1c94a8e0869c540f140d4216bde604535ab2e195b3b0869eb6 |
|
MD5 | 0c1e79fce7db55d8a20a468fa852160f |
|
BLAKE2b-256 | f84f5cc63ec81191071e36d4156a007e7be239d04ec0f7326074619f7395824e |
Hashes for alliance_platform_frontend-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd02e39f2c7a65fc455c03b02380df74f2df450e2582c528209d5d0260ea3578 |
|
MD5 | 4c11a32b543e1349fa5be59af6ba3749 |
|
BLAKE2b-256 | 17e73d4a1b16df3216000affb56a26818414f077d5e111821da2d911d0b9aa61 |