valar for morghulis
1. installation
- you need to install valar in a django project
pip install valar
2. root app
- you only need 3 files in your root app
- settings.py
- asgi.py
- urls.py
- __init__.py
settings.py
from pathlib import Path
""" Compulsory settings """
DEBUG = True
BASE_DIR = Path(__file__).resolve().parent.parent
BASE_APP = str(BASE_DIR.name)
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
SECRET_KEY = 'django-insecure-of@tfouoq^_f$l!yki#m=6j7)@&kjri$1_$!mca-=%7=+@f@5^'
""" Minimized compulsory settings """
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
INSTALLED_APPS = [
'django.contrib.sessions',
"corsheaders",
'channels',
'valar.apps.ValarConfig',
]
MIDDLEWARE = [
'django.contrib.sessions.middleware.SessionMiddleware',
'corsheaders.middleware.CorsMiddleware',
'django.middleware.common.CommonMiddleware',
'valar.system.middleware.ValarMiddleware'
]
CHANNEL_LAYERS = {
"default": {
"BACKEND": "channels.layers.InMemoryChannelLayer"
}
}
CORS_ORIGIN_ALLOW_ALL = True
CORS_ALLOW_CREDENTIALS = True
ROOT_URLCONF = "%s.urls" % BASE_APP
ASGI_APPLICATION = "%s.asgi.application" % BASE_APP
""" Optional settings """
ALLOWED_HOSTS = ['*']
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_TZ = False
SESSION_SAVE_EVERY_REQUEST = True
SESSION_COOKIE_AGE = 60 * 60
FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
""" Valar Options """
VALAR_HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
VALAR_MINIO_URL = "s3://admin:__password__@___host__:___port___"
""" Email Options """
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.____.com'
EMAIL_PORT = 25
EMAIL_HOST_USER = "______@____.com"
EMAIL_HOST_PASSWORD = '______'
init.py (when using MySQL)
import pymysql
pymysql.install_as_MySQLdb()
asgi.py
import os
from pathlib import Path
from typing import cast, Callable, Any
from channels.routing import ProtocolTypeRouter, URLRouter
from django.core.asgi import get_asgi_application
from django.urls import re_path
from valar.system.socket.consumer import ValarConsumer
asgi_router_list = [
re_path(
r'(?P<client>\w+)/$',
cast(Callable[..., Any], ValarConsumer.as_asgi())
),
]
os.environ.setdefault('DJANGO_SETTINGS_MODULE', '%s.settings' % Path(__file__).resolve().parent.parent.name)
application = ProtocolTypeRouter({
'http': get_asgi_application(),
'websocket': URLRouter(cast(Any, asgi_router_list))
})
urls.py
urlpatterns = [
]
channel_mapping = {
}
- go to section 4 to see how to register channel handlers (a Vue - Django async communication tool) in urls.
3. migrate
- no need to makemigrations and migrate for valar, valar will auto migration
4. how to register a channel handler for Morghulis async methods
4.1 create a handler
4.2 create a dict (e.g. using the name 'channel_mapping') to save your handler
- I'd like to put it in the root urls.py, you can put it anywhere
4.3 register the channel_mapping in the settings.py
4.4 you can copy the following codes to your urls.py
5. create an orm model extends the AbstractUser class, enable the authentication of Valar
class User(AbstractUser):
"""
any fields you want
"""
description = models.TextField(null=True, verbose_name='备注')
class Meta:
verbose_name = 'User'
1 maintainer
Metadata
1 maintainer
Release files for valar 2.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| valar-2.0.4.tar.gz | 35.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| valar-2.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 78.3 kB
Release files / valar-2.0.4.tar.gz
| Download URL | valar-2.0.4.tar.gz |
|---|---|
| Size | 35.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c960e5663dafaf2851915f0c746071443147d39bd31e0b03f0226a970d9b4dc3
|
|
BLAKE2b-256 checksum How to use checksums |
c73f96180e589fdc2ad4b3331a369b24f9529c4db68fefb3e287b5dd7cf50126
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Release files / valar-2.0.4-py3-none-any.whl
| Download URL | valar-2.0.4-py3-none-any.whl |
|---|---|
| Size | 42.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bfd4a41bef6500952509ca814e713f069721af116a739acd75be5839024c652b
|
|
BLAKE2b-256 checksum How to use checksums |
0052df9f24eff8b8a800643f4795d244d10311cf781adbf9c255a32c0a8a77c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Security for valar 2.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
