valar 1.2.4__tar.gz → 1.2.5__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valar
-Version: 1.2.4
+Version: 1.2.5
 Summary: valar for morghulis
 Home-page: https://gitee.com/GRIFFIN120/valar_dev
 Author: LYP
@@ -30,11 +30,20 @@ valar for morghulis
 
 # 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 pathlib import Path
@@ -99,7 +108,7 @@ MINIO_ROOT = "https://host:9001"
 
 ```
 
-# 2. asgi
+## 2.2 asgi.py
 
 ```python
 from django.core.asgi import get_asgi_application
@@ -118,18 +127,19 @@ application = ProtocolTypeRouter({
 
 ```
 
-# 3. migrate
+## 2.3 urls.py
 
-- no need to makemigrations and migrate for valar, 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 to provide urls for val, valar will auto set urlpatterns for Morghulis (
-see https://www.npmjs.com/package/morghulis)
+- no need to makemigrations and migrate for valar, valar will auto migration
 
-# 5. how to register a channel handler for Morghulis async methods
+# 4. how to register a channel handler for Morghulis async methods
 
-## 5.1 create a handler
+## 4.1 create a handler
 
 ```python
 import time
@@ -148,7 +158,7 @@ def valar_test_handler(sender: ValarChannelSender):
         sender.load(tick)
 ```
 
-### 5.2 create a dict (e.g. using the name 'channel_mapping') to save your 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
 
@@ -158,13 +168,13 @@ channel_mapping = {
 }
 ```
 
-## 5.2 register the channel_mapping in the settings.py
+## 4.3 register the channel_mapping in the settings.py
 
 ```python
 HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
 ```
 
-### 5.4 you can copy the following codes to your urls.py
+### 4.4 you can copy the following codes to your urls.py
 
 ```python
 import json

{valar-1.2.4 → valar-1.2.5}/README.md

@@ -2,11 +2,20 @@ valar for morghulis
 
 # 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 pathlib import Path
@@ -71,7 +80,7 @@ MINIO_ROOT = "https://host:9001"
 
 ```
 
-# 2. asgi
+## 2.2 asgi.py
 
 ```python
 from django.core.asgi import get_asgi_application
@@ -90,18 +99,19 @@ application = ProtocolTypeRouter({
 
 ```
 
-# 3. migrate
+## 2.3 urls.py
 
-- no need to makemigrations and migrate for valar, 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 to provide urls for val, valar will auto set urlpatterns for Morghulis (
-see https://www.npmjs.com/package/morghulis)
+- no need to makemigrations and migrate for valar, valar will auto migration
 
-# 5. how to register a channel handler for Morghulis async methods
+# 4. how to register a channel handler for Morghulis async methods
 
-## 5.1 create a handler
+## 4.1 create a handler
 
 ```python
 import time
@@ -120,7 +130,7 @@ def valar_test_handler(sender: ValarChannelSender):
         sender.load(tick)
 ```
 
-### 5.2 create a dict (e.g. using the name 'channel_mapping') to save your 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
 
@@ -130,13 +140,13 @@ channel_mapping = {
 }
 ```
 
-## 5.2 register the channel_mapping in the settings.py
+## 4.3 register the channel_mapping in the settings.py
 
 ```python
 HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
 ```
 
-### 5.4 you can copy the following codes to your urls.py
+### 4.4 you can copy the following codes to your urls.py
 
 ```python
 import json

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

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valar
-Version: 1.2.4
+Version: 1.2.5
 Summary: valar for morghulis
 Home-page: https://gitee.com/GRIFFIN120/valar_dev
 Author: LYP
@@ -30,11 +30,20 @@ valar for morghulis
 
 # 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 pathlib import Path
@@ -99,7 +108,7 @@ MINIO_ROOT = "https://host:9001"
 
 ```
 
-# 2. asgi
+## 2.2 asgi.py
 
 ```python
 from django.core.asgi import get_asgi_application
@@ -118,18 +127,19 @@ application = ProtocolTypeRouter({
 
 ```
 
-# 3. migrate
+## 2.3 urls.py
 
-- no need to makemigrations and migrate for valar, 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 to provide urls for val, valar will auto set urlpatterns for Morghulis (
-see https://www.npmjs.com/package/morghulis)
+- no need to makemigrations and migrate for valar, valar will auto migration
 
-# 5. how to register a channel handler for Morghulis async methods
+# 4. how to register a channel handler for Morghulis async methods
 
-## 5.1 create a handler
+## 4.1 create a handler
 
 ```python
 import time
@@ -148,7 +158,7 @@ def valar_test_handler(sender: ValarChannelSender):
         sender.load(tick)
 ```
 
-### 5.2 create a dict (e.g. using the name 'channel_mapping') to save your 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
 
@@ -158,13 +168,13 @@ channel_mapping = {
 }
 ```
 
-## 5.2 register the channel_mapping in the settings.py
+## 4.3 register the channel_mapping in the settings.py
 
 ```python
 HANDLER_MAPPING = "%s.urls.channel_mapping" % BASE_APP
 ```
 
-### 5.4 you can copy the following codes to your urls.py
+### 4.4 you can copy the following codes to your urls.py
 
 ```python
 import json