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.11.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.11.tar.gz
Algorithm Hash digest
SHA256 d35fea09893a2e944ae6814b264a2a2c138669f6dd416cb8b130fa5a69387447
MD5 5c6d1b8a8406e5960c2d6176922705ba
BLAKE2b-256 96238c2bae085d3c3c04022a34cf1d4d7cb5133eed4e3a210aad52f1b89899e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7b80ccf63c51f29931906e2c8d6adf4e178ee5b3f0d1adf3240d79abfc7175
MD5 eeb21fdac9a68dfad5d6c44c1c1ef863
BLAKE2b-256 8af476b7727689e30a825414348ba6c88de73aad9493d679baa322b8630f3aa0

See more details on using hashes here.

Supported by

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