✨ => new cool features added and some breaking changes

Author: NaviTheCoderboi

.gitignore

@@ -1,5 +1,3 @@
-
-
 ### Python template
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -18,6 +16,7 @@ testing/*
 build/
 develop-eggs/
 dist/
+!vivid/router/dist
 downloads/
 eggs/
 .eggs/
@@ -158,4 +157,4 @@ poetry.lock
 
 # Mkdocs
 
-site/
+site/

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args:
+          - --markdown-linebreak-ext=md
+      - id: check-toml
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0
+    hooks:
+      - id: python-use-type-annotations
+      - id: python-check-blanket-noqa
+
+  - repo: local
+    hooks:
+      - id: isort
+        name: isort
+        pass_filenames: false
+        entry: poetry run isort .
+        language: python
+        stages:
+          - commit
+
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        pass_filenames: false
+        entry: poetry run black .
+        language: python
+        stages:
+          - commit
+
+  - repo: local
+    hooks:
+      - id: ruff
+        name: ruff
+        pass_filenames: false
+        entry: poetry run ruff .
+        language: python
+        stages:
+          - commit
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        pass_filenames: false
+        entry: poetry run mypy .
+        language: python
+        stages:
+          - commit
+
+  # - repo: local
+  #   hooks:
+  #     - id: changelog
+  #       name: changelog
+  #       pass_filenames: false
+  #       entry: poetry run auto-changelog --template ./templates/custom.jinja2 --tag-prefix v --unreleased
+  #       language: system
+  #       stages:
+  #         - commit

CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## 1.0.0-alpha2 - 4 Feb, 2024
+### new features
+- SSG support (static site generation)
+### fixes
+- renamed router to app for more context
+- add logging to framework
+- made cli better
+### breaking changes
+- `router` is now `app`
+- `vivid new` is now `vivid init
+- `vivid serve` is removed
+### removals
+- `vivid serve` is removed
+### docs
+- added more documentation
+- renamed `router` to `app` in documentation
+### promises
+- added guides
+
+## 1.0.0-alpha1 - 1 Feb, 2024
+### new features
+
+- File system routing
+- Server data fetching support
+- Static file serving
+- ASGI support

README.md

@@ -30,11 +30,10 @@ python3 -m pip install vivid
 To create a **Vivid** project you need to open a command line and type below command
 
 ```
-python -m vivid new project -p .
+python -m vivid init ...
 ```
-
 > [!NOTE]
-> **-p** is shorthand for **--path**
+> Don't forget to replace **...** with your project name
 
 ## walkthrough
 
@@ -44,7 +43,7 @@ you need to export a load function which returns a response, below is given an e
 for example **index.py**
 
 ```python
-from vivid.router import Response
+from vivid.app import Response
 
 async def load():
     return Response(200,[], { "name": "John" })

docs/api_reference/app.md

@@ -0,0 +1 @@
+::: vivid.app.App

docs/api_reference/router.md

@@ -16,25 +16,25 @@
 To install **Vivid** library, open a command line then write things those are below
 
 ```sh
-python -m pip install vivid
+python -m pip install git+https://github.com/NaviTheCoderboi/vivid.git
 ```
 
 If the top command isn't working, try this one
 
 ```sh
-python3 -m pip install vivid
+python3 -m pip install git+https://github.com/NaviTheCoderboi/vivid.git
 ```
 
 ## Start quickly by creating project
 
 To create a **Vivid** project you need to open a command line and type below command
 
 ```
-python -m vivid new project -p .
+python -m vivid init ...
 ```
 
 !!! note "Note"
-    **-p** is shorthand for **--path**
+	Don't forget to replace **...** with your project name
 
 ## walkthrough
 
@@ -44,7 +44,7 @@ you need to export a load function which returns a response, below is given an e
 for example **index.py**
 
 ```python
-from vivid.router import Response
+from vivid.app import Response
 
 async def load():
     return Response(200,[], { "name": "John" })

docs/index.md

@@ -9,7 +9,7 @@ extra:
   social:
     - icon: material/github
       url: https://github.com/NaviTheCoderboi/vivid
-  version: 1.0.0-alpha1
+  version: 1.0.0-alpha2
 
 theme:
   name: "material"
@@ -63,6 +63,6 @@ markdown_extensions:
 nav:
   - Api Reference:
       - Http: api_reference/http.md
-      - Router: api_reference/router.md
+      - App: api_reference/app.md
   - Guides:
       - Basic: guides/basic.md