https://github.com/loadsmart/django-frontend-settings

https://github.com/loadsmart/django-frontend-settings

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/loadsmart/django-frontend-settings
• Owner: loadsmart
• License: mit
• Created: 2021-07-02T14:25:28.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-26T17:16:59.000Z (over 1 year ago)
• Last Synced: 2025-03-28T10:47:32.804Z (about 1 year ago)
• Language: Python
• Size: 29.3 KB
• Stars: 5
• Watchers: 58
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
Frontend Settings

=================

Abstract

--------

This project provides an API that expose settings and feature flags for the frontend.

It uses `django-drf` to create an endpoint to expose flags and settings configured in `django-waffle` and `django-constance`

Usage

-----

Requirements

Python (3.6, 3.7, 3.8, 3.9)

Django (2.2, 3.0, 3.1, 3.2)

Installation

~~~~~~~~~~~~

Install using pip:

.. code::

    pip install django-frontend-settings

Add 'frontend-settings' to your INSTALLED_APPS setting.

.. code:: python

    INSTALLED_APPS = [

        ...

        'frontend_settings',

    ]

Expose the view in your urls:

.. code:: python

    from frontend_settings.views import settings as frontend_settings_view

    url(r"^frontend-settings/", frontend_settings_view, name="frontend-settings"),

Then your flags from waffle and setting from constance should be returned on a get in this route:

.. code::

    $ curl 'http://localhost:8000/frontend-settings/'

    {"data":{"flags":{"MY_FEATURE_FLAG":true},"settings":{}}}

In that case I had `FRONTEND_MY_FEATURE_FLAG` flag in waffle.

The default prefix for flags is `FRONTEND_`, if you like to change it you can do by changing the following config on settings.py:

.. code:: python

    FRONTEND_SETTINGS = {

        "WAFFLE_FLAG_PREFIX": "FRONTEND_", # Prefix used to filter out the flag that should be exposed in the endpoint

        "CONSTANCE_KEY_PREFIX": "FRONTEND_", # Prefix used to filter out the settings in constance

    }