https://github.com/bitsy-ai/django-ghost

Django app to sync a Django user/auth model with Ghost CMS newsletter subscribers
https://github.com/bitsy-ai/django-ghost

Last synced: 20 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bitsy-ai/django-ghost
• Owner: bitsy-ai
• License: bsd-3-clause
• Created: 2022-11-17T17:36:52.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-28T01:26:51.000Z (almost 2 years ago)
• Last Synced: 2024-12-15T19:48:22.464Z (about 1 month ago)
• Language: Python
• Homepage:
• Size: 78.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Ghost

[![image](https://img.shields.io/pypi/v/django-ghost)](https://pypi.org/project/django-ghost/) [![image](https://img.shields.io/pypi/pyversions/django-ghost)](https://pypi.org/project/django-ghost/) [![image](https://img.shields.io/pypi/djversions/django-ghost)](https://pypi.org/project/django-ghost/) [![image](https://img.shields.io/pypi/wheel/django-ghost)](https://pypi.org/project/django-ghost/) [![image](https://img.shields.io/discord/773452324692688956)](https://discord.gg/Y848Hq9xKh) [![image](https://img.shields.io/github/workflow/status/bitsy-ai/django-ghost/Test)](https://github.com/bitsy-ai/django-ghost) [![image](https://img.shields.io/codecov/c/github/bitsy-ai/django-ghost)](https://github.com/bitsy-ai/django-ghost) [![image](https://img.shields.io/github/release-date-pre/bitsy-ai/django-ghost)](https://github.com/bitsy-ai/django-ghost)

Automatically sync a Django model with Ghost's member model. [Ghost is a CMS for content creators.](https://ghost.org/)

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)