Skip to main content

An easy way to setup a database site.

Project description

CosmicDBSemantic Django App

Install

virtualenv demoenv --no-site-packages
demoenv\Scripts\activate
pip install cosmicdbsemantic
django-admin startproject demo

Usage

Add cosmicdb and requirements to your INSTALLED_APPS setting like this (your app must be first to override)

INSTALLED_APPS = (
    'YOURAPPHERE',
    'cosmicdb',
    'crispy_forms',
    'sitetree',
    'django_tables2',
    ... (rest of django apps)
)

Add cosmicdb.urls to your urls.py like this (put cosmicdb urls last)

from django.contrib import admin
from django.urls import path, re_path, include

urlpatterns = [
    re_path(r'^', include('cosmicdb.urls')),
    path('admin/', admin.site.urls),
]

Add cosmicdb settings to your settings.py like this

LANGUAGE_CODE = 'en-au'
COSMICDB_SITE_TITLE = 'Demo Site'
CRISPY_TEMPLATE_PACK = 'semanticui'
CRISPY_ALLOWED_TEMPLATE_PACKS = (CRISPY_TEMPLATE_PACK)
DJANGO_TABLES2_TEMPLATE = 'django_tables2/semantic.html'
COSMICDB_ALLOW_SIGNUP = True
AUTH_USER_MODEL = 'cosmicdb.User'
LOGIN_URL = '/login/'
EMAIL_USE_TLS = True
EMAIL_HOST = 'mysmtp.smtp.com'
EMAIL_PORT = 465
EMAIL_HOST_USER = 'mysmtpuser'
EMAIL_HOST_PASSWORD = 'mysmtppw'
DEFAULT_FROM_EMAIL = EMAIL_HOST_USER
DEFAULT_FROM_EMAIL_NAME = COSMICDB_SITE_TITLE
SITETREE_MODEL_TREE = 'cosmicdb.CosmicDBTree'
SITETREE_MODEL_TREE_ITEM = 'cosmicdb.CosmicDBTreeItem'

Run

python manage.py migrate
python manage.py collectstatic
python manage.py createsuperuser

Load sitetree from site-packages for now

python manage.py sitetreeload SITE_PACKAGES_DIR/cosmicdb/treedump.json

Installation Complete!

Optional

Custom Semantic UI Themes

NodeJS (npm)

Gulp

npm install -g gulp
npm install -g gulp-cli

Add NODE_PATH env

Semantic UI

cd PROJECT_DIR\cosmicdb\res\
npm install semantic-ui --save

Put semanticui in semantic

cd semantic/
gulp build

Now you can copy your own theme from dist to cosmicdb\static\

cd PROJECT ROOT
cp -rf cosmicdb/res/semanticui/semantic/dist cosmicdb/static/cosmicdb/semantic

Site Tree

Generate sitetree

python manage.py sitetreedump > treedump.json

Dev Notes

adjust cosmicdb/init.py for version number

python setup.py sdist bdist_wheel

replace the following line with version number

twine upload dist/cosmicdbsemantic-0.0.1*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cosmicdbsemantic-0.0.14.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cosmicdbsemantic-0.0.14-py3-none-any.whl (4.8 MB view details)

Uploaded Python 3

File details

Details for the file cosmicdbsemantic-0.0.14.tar.gz.

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.14.tar.gz
Algorithm Hash digest
SHA256 ef12f89206445da0d128efa6bb6470fbbb6fa8faeff3b8edee39ce0fe4976e91
MD5 e6240654c6e152419b2be79e52a3691b
BLAKE2b-256 e7730032ba8dd1c8c376d2a8c1c1c36be572dd5a8f35f011ce0e1ecc63de8286

See more details on using hashes here.

File details

Details for the file cosmicdbsemantic-0.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 8efa0f134ac60652603fce4960aefa1fc605ef282b5adc15d5262544e8ef57d9
MD5 3fc90b300932ef457b8e71afbf0be871
BLAKE2b-256 c9c6713683760f9dff6f66d58bb8cf62022485598f4bd4a70b0fc1579df4fea1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page