Skip to main content

Terra Nanotech Template Overrides for Alliance Auth

Project description

Terra Nanotech Auth Templates

Version GitHub license Python Django pre-commit pre-commit.ci status Code Style: black Checks codecov

Terra Nanotech Template Overrides for Alliance Auth

TN-NT Auth Template



Important Information

[!IMPORTANT]

This template override needs Alliance Auth v4!

Please make sure to update your Alliance Auth instance before you install this version, otherwise an update to Alliance Auth will be pulled in unsupervised.

This template override is not compatible with Alliance Auth v3.x!

For versions compatible with Alliance Auth v3.x, see the Releases before v3.0.0.

[!WARNING]

These template overrides are specially tailored for the corporation Terra Nanotech. They override templates of apps we use, so it looks like we want it to. This might entail changes to templates that also change the behavior in a way we like it to be changed.

If you install these template overrides, you need to be aware that there will be no support for any kind of issues you might encounter, and you have to figure it out on your own.

Install

pip install tnnt-templates

In local.py right after INSTALLED_APPS:

# TN-NT Auth Templates - https://github.com/terra-nanotech/tn-nt-auth-templates
INSTALLED_APPS.insert(
    0, "tnnt_templates"
)  # Bootstrap 3 fallback for AA community app that haven't been updated to Bootstrap 5 yet.

if "tnnt_templates" in INSTALLED_APPS:
    # Add TN-NT Auth Templates theme
    INSTALLED_APPS += [
        "tnnt_templates.theme.terra_nanotech",
    ]

    # Remove all other themes
    # If you want to use the TN-NT Auth Templates as the only theme,
    # you need to remove all other themes.
    INSTALLED_APPS.remove("allianceauth.theme.darkly")
    INSTALLED_APPS.remove("allianceauth.theme.flatly")
    INSTALLED_APPS.remove("allianceauth.theme.materia")

    # If you are using AA-GDPR, you need to remove the darkly, flatly and materia themes
    # added by AA-GDPR as well.
    if "aagdpr" in INSTALLED_APPS:
        INSTALLED_APPS.remove("aagdpr.theme.darkly")
        INSTALLED_APPS.remove("aagdpr.theme.flatly")
        INSTALLED_APPS.remove("aagdpr.theme.materia")

    # Load Terra Nanotech theme
    DEFAULT_THEME = (
        "tnnt_templates.theme.terra_nanotech.auth_hooks.TerraNanotechThemeHook"
    )
    # Legacy AAv3 user.profile.night_mode=1
    DEFAULT_THEME_DARK = (
        "tnnt_templates.theme.terra_nanotech.auth_hooks.TerraNanotechThemeHook"
    )

    # Add TN-NT Auth Templates context processor
    TEMPLATES[0]["OPTIONS"]["context_processors"].append(
        "tnnt_templates.context_processors.tnnt_settings"
    )

    # Add TN-NT Auth Templates settings
    TNNT_TEMPLATE_ENTITY_ID = 8154711  #  replace with your corp/alliance ID
    TNNT_TEMPLATE_ENTITY_TYPE = "corporation"  # default: "alliance"
    TNNT_TEMPLATE_ENTITY_NAME = "My Awesome Corp/Alliance"  # your corp/alliance name

Important

If you are using AA-GDPR, the template stuff needs to be after the AA_GDPR entry, like this:

# GDPR Compliance
INSTALLED_APPS.insert(0, "aagdpr")
AVOID_CDN = True


# TN-NT Auth Templates
INSTALLED_APPS.insert(0, "tnnt_templates")

Project details


Release history Release notifications | RSS feed

This version

3.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tnnt_templates-3.0.2.tar.gz (5.5 MB view hashes)

Uploaded Source

Built Distribution

tnnt_templates-3.0.2-py3-none-any.whl (6.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page