Metadata-Version: 2.1
Name: django-willing-zg
Version: 0.8.0
Summary: 
Author: Bequest, Inc.
Author-email: oss@willing.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: cryptography (>=42.0.2)
Requires-Dist: django (>=4.2.10,<6.0)
Requires-Dist: djangorestframework (>=3.14.0,<4.0.0)
Requires-Dist: djangorestframework-simplejwt (>=5.3.1,<6.0.0)
Requires-Dist: pytest (>=8.0.0,<9.0.0)
Requires-Dist: simplejwt-extensions (>=0.2.1,<0.3.0)
Requires-Dist: zygoat-django (>=1.0.1)
Description-Content-Type: text/markdown

# django-willing-zg
A Django app to hold common utilities for Zygoat-managed applications


## What it does
`willing_zg` provides a means to define frontend configuration in the django settings and an API endpoint to make that configuration accessible.

## Usage
1. Add "willing_zg" to `INSTALLED_APPS` in the django settings

2. Define `ZYGOAT_FRONTEND_META_CONFIG` in the django settings

    ZYGOAT_FRONTEND_META_CONFIG = { "example_frontend_config": "example_value" }

3. Include the willing_zg URLconf in your project's urls.py:

    path('api/zygoat/', include('willing_zg.urls')),

4. Import willing-zg settings into the django settings

   from willing_zg.settings import * # noqa


## Running locally for development
1. checkout the directory into the `backend` directory of the app you're developing in

2. modify your Dockerfile.local and add `ADD /django-willing-zg /django-willing-zg` above `WORKDIR /code` and add ` RUN poetry add --editable /django-willing-zg` after poetry install

