valar 1.2.3__tar.gz → 1.2.5__tar.gz

{valar-1.2.3/src/valar.egg-info → valar-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valar
-Version: 1.2.3
+Version: 1.2.5
 Summary: valar for morghulis
 Home-page: https://gitee.com/GRIFFIN120/valar_dev
 Author: LYP
@@ -28,33 +28,34 @@ Dynamic: summary
 
 valar for morghulis
 
-# 1. install
+# 1. installation
+
+- you need to install valar in a django project
 
 ```shell
 pip install valar
 ```
 
-# 1. settings
+# 2. root app
+
+- you only need 3 files in your root app
+    - settings.py
+    - asgi.py
+    - urls.py
+
+## 2.1 settings.py
 
 ```python
-from django.core.management.utils import get_random_secret_key
 from pathlib import Path
 
-"""       Compulsory settings       """
-
+""" 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 = get_random_secret_key()
-
-"""       Valar Options       """
+SECRET_KEY = 'django-insecure-of@tfouoq^_f$l!yki#m=6j7)@&kjri$1_$!mca-=%7=+@f@5^'
 
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
-MONGO_URI = 'mongodb://root:19870120@121.41.111.175:27017/'
-MINIO_URL = "s3://admin:password@120.27.8.186:9000"
-
-"""       Minimized compulsory settings       """
+""" Minimized compulsory settings """
 
 DATABASES = {
     'default': {
@@ -62,29 +63,32 @@ DATABASES = {
         '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',
 ]
+
 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       """
-
+""" Optional settings """
 ALLOWED_HOSTS = ['*']
 LANGUAGE_CODE = 'en-us'
 TIME_ZONE = 'Asia/Shanghai'
@@ -95,14 +99,22 @@ SESSION_COOKIE_AGE = 60 * 60
 FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 
+""" Valar Options """
+
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+MONGO_URI = 'mongodb://username:password@host:27017'
+MINIO_URL = "s3://username:password@host:9000"
+MINIO_ROOT = "https://host:9001"
+
 ```
 
-# 2. asgi
+## 2.2 asgi.py
 
 ```python
 from django.core.asgi import get_asgi_application
 from channels.routing import ProtocolTypeRouter, URLRouter
 from django.urls import re_path
+
 from valar.channels.consumer import ValarConsumer
 
 application = ProtocolTypeRouter({
@@ -112,39 +124,78 @@ application = ProtocolTypeRouter({
     ])
 })
 
+
 ```
 
-# 3. migrate
+## 2.3 urls.py
 
-no need, valar will auto migration
+- no need to provide urls for Valar, Valar will auto set urlpatterns for Morghulis (
+  see https://www.npmjs.com/package/morghulis)
+- go to section 4 to see how to register channel handlers (a Vue - Django async communication tool) in urls.
 
-# 4. root urls
+# 3. migrate
 
-no need, valar will auto set urlpatterns
+- no need to makemigrations and migrate for valar, valar will auto migration
 
-# 5. how to use valar_channel
+# 4. how to register a channel handler for Morghulis async methods
 
-5.1 set HANDLER_MAPPING in settings
+## 4.1 create a handler
 
 ```python
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+import time
+from valar.channels.sender import ValarChannelSender
+from valar.channels.counter import Counter
+
+
+def valar_test_handler(sender: ValarChannelSender):
+    data = sender.data
+    length = data.get('length', 100)
+    counter = Counter(length)
+    for i in range(length):
+        time.sleep(0.1)
+        tick = counter.tick()
+        tick.update({'name': 'test1'})
+        sender.load(tick)
 ```
 
-5.2 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
 
 ```python
-from valar.channels.sender import ValarSocketSender
+channel_mapping = {
+    'test': valar_test_handler,
+}
+```
 
+## 4.3 register the channel_mapping in the settings.py
 
-def test_handler(sender: ValarSocketSender):
-    data = sender.data
-    sender.load(data)
+```python
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
 ```
 
-5.3 register handler in channel_mapping
+### 4.4 you can copy the following codes to your urls.py
 
 ```python
+import json
+
+from django.urls import path
+
+from valar.classes.valar_response import ValarResponse
+from valar.views.handler import valar_test_handler
+
+
+def test_request(request):
+    body = json.loads(request.body)
+    return ValarResponse(body)
+
+
+urlpatterns = [
+    path('test', test_request),
+]
+
 channel_mapping = {
-    'test': test_handler,
+    'test_handler': valar_test_handler,
 }
+
 ```

valar-1.2.5/README.md

@@ -0,0 +1,173 @@
+valar for morghulis
+
+# 1. installation
+
+- you need to install valar in a django project
+
+```shell
+pip install valar
+```
+
+# 2. root app
+
+- you only need 3 files in your root app
+    - settings.py
+    - asgi.py
+    - urls.py
+
+## 2.1 settings.py
+
+```python
+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',
+]
+
+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 """
+
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+MONGO_URI = 'mongodb://username:password@host:27017'
+MINIO_URL = "s3://username:password@host:9000"
+MINIO_ROOT = "https://host:9001"
+
+```
+
+## 2.2 asgi.py
+
+```python
+from django.core.asgi import get_asgi_application
+from channels.routing import ProtocolTypeRouter, URLRouter
+from django.urls import re_path
+
+from valar.channels.consumer import ValarConsumer
+
+application = ProtocolTypeRouter({
+    'http': get_asgi_application(),
+    'websocket': URLRouter([
+        re_path(r'(?P<client>\w+)/$', ValarConsumer.as_asgi()),
+    ])
+})
+
+
+```
+
+## 2.3 urls.py
+
+- no need to provide urls for Valar, Valar will auto set urlpatterns for Morghulis (
+  see https://www.npmjs.com/package/morghulis)
+- 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
+
+```python
+import time
+from valar.channels.sender import ValarChannelSender
+from valar.channels.counter import Counter
+
+
+def valar_test_handler(sender: ValarChannelSender):
+    data = sender.data
+    length = data.get('length', 100)
+    counter = Counter(length)
+    for i in range(length):
+        time.sleep(0.1)
+        tick = counter.tick()
+        tick.update({'name': 'test1'})
+        sender.load(tick)
+```
+
+### 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
+
+```python
+channel_mapping = {
+    'test': valar_test_handler,
+}
+```
+
+## 4.3 register the channel_mapping in the settings.py
+
+```python
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+```
+
+### 4.4 you can copy the following codes to your urls.py
+
+```python
+import json
+
+from django.urls import path
+
+from valar.classes.valar_response import ValarResponse
+from valar.views.handler import valar_test_handler
+
+
+def test_request(request):
+    body = json.loads(request.body)
+    return ValarResponse(body)
+
+
+urlpatterns = [
+    path('test', test_request),
+]
+
+channel_mapping = {
+    'test_handler': valar_test_handler,
+}
+
+```

{valar-1.2.3 → valar-1.2.5}/setup.py

@@ -16,7 +16,7 @@ requires = [
 
 setup(
     name="valar",  # 包名
-    version="1.2.3",  # 版本号
+    version="1.2.5",  # 版本号
     author="LYP",  # 作者
     author_email="liuyinpeng@buaa.edu.cn",  # 邮箱
     description="valar for morghulis",  # 简短描述

{valar-1.2.3 → valar-1.2.5/src/valar.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valar
-Version: 1.2.3
+Version: 1.2.5
 Summary: valar for morghulis
 Home-page: https://gitee.com/GRIFFIN120/valar_dev
 Author: LYP
@@ -28,33 +28,34 @@ Dynamic: summary
 
 valar for morghulis
 
-# 1. install
+# 1. installation
+
+- you need to install valar in a django project
 
 ```shell
 pip install valar
 ```
 
-# 1. settings
+# 2. root app
+
+- you only need 3 files in your root app
+    - settings.py
+    - asgi.py
+    - urls.py
+
+## 2.1 settings.py
 
 ```python
-from django.core.management.utils import get_random_secret_key
 from pathlib import Path
 
-"""       Compulsory settings       """
-
+""" 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 = get_random_secret_key()
-
-"""       Valar Options       """
+SECRET_KEY = 'django-insecure-of@tfouoq^_f$l!yki#m=6j7)@&kjri$1_$!mca-=%7=+@f@5^'
 
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
-MONGO_URI = 'mongodb://root:19870120@121.41.111.175:27017/'
-MINIO_URL = "s3://admin:password@120.27.8.186:9000"
-
-"""       Minimized compulsory settings       """
+""" Minimized compulsory settings """
 
 DATABASES = {
     'default': {
@@ -62,29 +63,32 @@ DATABASES = {
         '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',
 ]
+
 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       """
-
+""" Optional settings """
 ALLOWED_HOSTS = ['*']
 LANGUAGE_CODE = 'en-us'
 TIME_ZONE = 'Asia/Shanghai'
@@ -95,14 +99,22 @@ SESSION_COOKIE_AGE = 60 * 60
 FILE_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 100
 
+""" Valar Options """
+
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+MONGO_URI = 'mongodb://username:password@host:27017'
+MINIO_URL = "s3://username:password@host:9000"
+MINIO_ROOT = "https://host:9001"
+
 ```
 
-# 2. asgi
+## 2.2 asgi.py
 
 ```python
 from django.core.asgi import get_asgi_application
 from channels.routing import ProtocolTypeRouter, URLRouter
 from django.urls import re_path
+
 from valar.channels.consumer import ValarConsumer
 
 application = ProtocolTypeRouter({
@@ -112,39 +124,78 @@ application = ProtocolTypeRouter({
     ])
 })
 
+
 ```
 
-# 3. migrate
+## 2.3 urls.py
 
-no need, valar will auto migration
+- no need to provide urls for Valar, Valar will auto set urlpatterns for Morghulis (
+  see https://www.npmjs.com/package/morghulis)
+- go to section 4 to see how to register channel handlers (a Vue - Django async communication tool) in urls.
 
-# 4. root urls
+# 3. migrate
 
-no need, valar will auto set urlpatterns
+- no need to makemigrations and migrate for valar, valar will auto migration
 
-# 5. how to use valar_channel
+# 4. how to register a channel handler for Morghulis async methods
 
-5.1 set HANDLER_MAPPING in settings
+## 4.1 create a handler
 
 ```python
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
+import time
+from valar.channels.sender import ValarChannelSender
+from valar.channels.counter import Counter
+
+
+def valar_test_handler(sender: ValarChannelSender):
+    data = sender.data
+    length = data.get('length', 100)
+    counter = Counter(length)
+    for i in range(length):
+        time.sleep(0.1)
+        tick = counter.tick()
+        tick.update({'name': 'test1'})
+        sender.load(tick)
 ```
 
-5.2 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
 
 ```python
-from valar.channels.sender import ValarSocketSender
+channel_mapping = {
+    'test': valar_test_handler,
+}
+```
 
+## 4.3 register the channel_mapping in the settings.py
 
-def test_handler(sender: ValarSocketSender):
-    data = sender.data
-    sender.load(data)
+```python
+HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
 ```
 
-5.3 register handler in channel_mapping
+### 4.4 you can copy the following codes to your urls.py
 
 ```python
+import json
+
+from django.urls import path
+
+from valar.classes.valar_response import ValarResponse
+from valar.views.handler import valar_test_handler
+
+
+def test_request(request):
+    body = json.loads(request.body)
+    return ValarResponse(body)
+
+
+urlpatterns = [
+    path('test', test_request),
+]
+
 channel_mapping = {
-    'test': test_handler,
+    'test_handler': valar_test_handler,
 }
+
 ```

valar-1.2.3/README.md

@@ -1,122 +0,0 @@
-valar for morghulis
-
-# 1. install
-
-```shell
-pip install valar
-```
-
-# 1. settings
-
-```python
-from django.core.management.utils import get_random_secret_key
-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 = get_random_secret_key()
-
-"""       Valar Options       """
-
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
-MONGO_URI = 'mongodb://root:19870120@121.41.111.175:27017/'
-MINIO_URL = "s3://admin:password@120.27.8.186:9000"
-
-"""       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',
-]
-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
-
-```
-
-# 2. asgi
-
-```python
-from django.core.asgi import get_asgi_application
-from channels.routing import ProtocolTypeRouter, URLRouter
-from django.urls import re_path
-from valar.channels.consumer import ValarConsumer
-
-application = ProtocolTypeRouter({
-    'http': get_asgi_application(),
-    'websocket': URLRouter([
-        re_path(r'(?P<client>\w+)/$', ValarConsumer.as_asgi()),
-    ])
-})
-
-```
-
-# 3. migrate
-
-no need, valar will auto migration
-
-# 4. root urls
-
-no need, valar will auto set urlpatterns
-
-# 5. how to use valar_channel
-
-5.1 set HANDLER_MAPPING in settings
-
-```python
-HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
-```
-
-5.2 create a handler
-
-```python
-from valar.channels.sender import ValarSocketSender
-
-
-def test_handler(sender: ValarSocketSender):
-    data = sender.data
-    sender.load(data)
-```
-
-5.3 register handler in channel_mapping
-
-```python
-channel_mapping = {
-    'test': test_handler,
-}
-```