Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
gulliverbms committed Jun 3, 2018
1 parent 037c275 commit 6f60134
Show file tree
Hide file tree
Showing 18 changed files with 310 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,6 @@ docs/_build/

# PyBuilder
target/

db.*
TODO.*
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Changelog
=========
2 changes: 1 addition & 1 deletion LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

The MIT License (MIT)

Copyright (c) 2018
Copyright (c) 2018, Mark Burkut

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 4 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
include README.rst
include CHANGELOG.rst

include requirements.txt
1 change: 0 additions & 1 deletion README.md

This file was deleted.

50 changes: 50 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
django_grapesjs
================

A small library allows you to integrate "grapesjs" into django admin


Install
=======

.. code-block:: bash
pip install django_grapesjs
Then add it to your INSTALLED_APPS:

.. code-block:: python
INSTALLED_APPS = (
'django_grapesjs',
...
'django.contrib.admin',
)
Using
===============
Just import the field and add to your model

.. code-block:: python
from django.db import models
from django_grapesjs.models import GrapesJsHtmlField
class ExampleModel(models.Model):
html = GrapesJsHtmlField()
Custom Settings
===============

TEMPLATE_NAME = ''

Reference
===============
* `grapesjs`_


.. _`grapesjs`: https://github.com/artf/grapesjs

30 changes: 30 additions & 0 deletions example/TODO.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

- добавить возможность менять template -test
- добавить возможность css save -test
- сохранять текущее положение везде или только в данной записи (bool) -test
- добавить html default
- добавить html страничку default

- указать в реадми что это pagebuilder. Также призвать использовать это для mail рассылки
- добавить картинки


- проверить весь код, проверить работоспособность
- добавить значки
- добавить в pip
- протестировать вид в репозитории
- залить в репозиторий


протестировать на множество полей
протестировать в инлайнере


в будующем

- сохранять или предосохронять html в pagebuilder для каждой записи в моделе что то вроде default_html
- choices - добавить возможность

больше полей
поддержка инлайнеров

Empty file added example/__init__.py
Empty file.
Empty file added example/app/__init__.py
Empty file.
8 changes: 8 additions & 0 deletions example/app/admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
from django.contrib import admin
from app.models import ExampleModel


@admin.register(ExampleModel)
class ExampleAdmin(admin.ModelAdmin):
pass

5 changes: 5 additions & 0 deletions example/app/apps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
from django.apps import AppConfig


class ExampleConfig(AppConfig):
name = 'app'
22 changes: 22 additions & 0 deletions example/app/migrations/0001_initial.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Generated by Django 2.0.5 on 2018-05-31 18:50

from django.db import migrations, models
import django_grapesjs.models.fields


class Migration(migrations.Migration):

initial = True

dependencies = [
]

operations = [
migrations.CreateModel(
name='ExampleModel',
fields=[
('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('html', django_grapesjs.models.fields.GrapesJsHtmlField()),
],
),
]
Empty file.
7 changes: 7 additions & 0 deletions example/app/models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from django.db import models
from django_grapesjs.models import GrapesJsHtmlField


class ExampleModel(models.Model):
html = GrapesJsHtmlField()

126 changes: 126 additions & 0 deletions example/app/settings.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
"""
Django settings for example project.
Generated by 'django-admin startproject' using Django 2.0.5.
For more information on this file, see
https://docs.djangoproject.com/en/2.0/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.0/ref/settings/
"""

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '5hv632^^8)r1h)oicyk3zai_g#fb_7&&ekb+a$3lji#y+tot@%'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Application definition

INSTALLED_APPS = [
'app',

'django_grapesjs',

'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
]

MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'app.urls'

TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]

WSGI_APPLICATION = 'app.wsgi.application'


# Database
# https://docs.djangoproject.com/en/2.0/ref/settings/#databases

DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}


# Password validation
# https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
{
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
},
{
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
},
]


# Internationalization
# https://docs.djangoproject.com/en/2.0/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.0/howto/static-files/

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')

21 changes: 21 additions & 0 deletions example/app/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
"""example URL Configuration
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/2.0/topics/http/urls/
Examples:
Function views
1. Add an import: from my_app import views
2. Add a URL to urlpatterns: path('', views.home, name='home')
Class-based views
1. Add an import: from other_app.views import Home
2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
Including another URLconf
1. Import the include() function: from django.urls import include, path
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
"""
from django.contrib import admin
from django.urls import path

urlpatterns = [
path('admin/', admin.site.urls),
]
16 changes: 16 additions & 0 deletions example/app/wsgi.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
WSGI config for example project.
It exposes the WSGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/2.0/howto/deployment/wsgi/
"""

import os

from django.core.wsgi import get_wsgi_application

os.environ.setdefault("DJANGO_SETTINGS_MODULE", "app.settings")

application = get_wsgi_application()
15 changes: 15 additions & 0 deletions example/manage.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env python
import os
import sys

if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "app.settings")
try:
from django.core.management import execute_from_command_line
except ImportError as exc:
raise ImportError(
"Couldn't import Django. Are you sure it's installed and "
"available on your PYTHONPATH environment variable? Did you "
"forget to activate a virtual environment?"
) from exc
execute_from_command_line(sys.argv)

0 comments on commit 6f60134

Please sign in to comment.