/django-ghost

Django app to sync a Django user/auth model with Ghost CMS newsletter subscribers

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Django Ghost

image image image image image image image image

Automatically sync a Django model with Ghost's member model. Ghost is a CMS for content creators.

  1. pip install django-ghost

  2. Add to your INSTALLED_APPS settings:

    INSTALLED_APPS = [
        "django_ghost",
    ]
    
  3. Run python manage.py migrate to create the NATS organizationals models

Contributor's Guide

  1. Create a development environment (requires docker & docker-compose):

    make docker-up
    
  2. Run tests and generate a coverage report:

    make pytest
    
  3. Run black linter:

    make lint
    

Settings

Basic Settings

GHOST_SYNC_MODEL (default: return value of django.contrib.auth.get_user_model() )

GHOST_NEWSLETTER_IDS (default: []) - newsletter ids to subscribe to

GHOST_ADMIN_API_APP_ID

GHOST_ADMIN_API_APP_SECRET

GHOST_API_URL (default: "http://localhost or $GHOST_API_URL environment var)