alliance-platform-frontend

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
• Usage
  • Alliance UI
  • Bundler
  • Templates
  • Template Tags
• Release

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 at poetry-repository-testpypi
• 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 at poetry-repository-pypi

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 in pyproject.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