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 Django
django-admin startproject demo
pip install cosmicdbsemantic
```

## 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 = False
AUTH_USER_MODEL = 'cosmicdb.User'
LOGIN_URL = '/login/'
EMAIL_USE_TLS = True
EMAIL_HOST = 'smtp.mailtrap.io'
EMAIL_PORT = 465
EMAIL_HOST_USER = '31c8dd7fd64bdd'
EMAIL_HOST_PASSWORD = 'c11c8370e2408a'
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.4.tar.gz (4.6 MB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.4.tar.gz
Algorithm Hash digest
SHA256 49a991e6520ae2332b46ae605d96d6a1c9e12969e5eadd1ccefa884b656f297b
MD5 8dd590373b622acd758927d28b04477f
BLAKE2b-256 1145b1121fb1e4c8bd77c201373c87160309ce61cabb4b701ef0712c533198be

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cosmicdbsemantic-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f42971747340c3b51e87aeb129b15b8f76d002ae4a89fb8953a0ec400c39b6e6
MD5 b8ddc9ab661237b49c15e41d9dc31e9e
BLAKE2b-256 00c95292c0be7058b6494bbdac6b6f924849aefc0507af314c1b53deb19622bc

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