improve docs

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,27 @@
+commit a76cab9a9bdd17d48237519c9b1d6ea4f326c291
+Author: Alexeev Bronislav <[email protected]>
+Date:   Sun Apr 20 02:48:18 2025 +0700
+
+    fix docs
+
+commit c6a9f77396a5439e370d4e8a9ef483ae2ccf3d4b
+Author: Alexeev Bronislav <[email protected]>
+Date:   Sun Apr 20 02:44:31 2025 +0700
+
+    fix codestyle and docstrings
+
+commit 26136f2e901bd77b31fc4719a3abe97492be81b4
+Author: Alexeev Bronislav <[email protected]>
+Date:   Sun Apr 20 02:43:30 2025 +0700
+
+    fix codestyle and docstrings
+
+commit 5181990902fa69074dd227af5bc0ef305ead4943
+Author: Alexeev Bronislav <[email protected]>
+Date:   Sun Apr 20 02:04:58 2025 +0700
+
+    fix/feat: fix bugs in routing, add Router and methods, fix POST params
+
 commit 49ce678e2b66659829c44305be96bebb207d0c88
 Author: Alexeev Bronislav <[email protected]>
 Date:   Sat Apr 19 05:38:28 2025 +0700

README.md

@@ -39,9 +39,10 @@
     <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/alexeev-prog/pyEchoNext?style=for-the-badge">
 </p>
 
-<img src="https://github.com/alexeev-prog/pyEchoNext/actions/workflows/docs.yml/badge.svg">
+<p align="center">
+    <img src="https://raw.githubusercontent.com/alexeev-prog/pyEchoNext/refs/heads/main/docs/pallet-0.png">
+</p>
 
-![](./docs/pallet-0.png)
 
  > EchoNext is a lightweight, fast and scalable web framework for Python
  
@@ -54,12 +55,12 @@ Welcome to **EchoNext**, where innovation meets simplicity! Are you tired of the
 > Versions below 0.7.14a are not recommended for use with gunicorn <23.0 due to the fact that they used an older version of gunicorn (<23.0), which was [vulnerable](https://deps.dev/advisory/osv/GHSA-hc5x-x2vx-497g).
 
 <p align="center">
-    <img src="https://raw.githubusercontent.com/alexeev-prog/pyEchoNext/refs/heads/main/docs/logo.jpg">
+    <img src="https://raw.githubusercontent.com/alexeev-prog/pyEchoNext/refs/heads/main/docs/logo.jpg" width="70%" height="70%" >
 </p>
 
 **Imagine** a lightweight framework that empowers you to create modern web applications with lightning speed and flexibility. With EchoNext, you're not just coding; you're building a masterpiece!
 
- > Last stable version: 0.7.13 alpha
+ > Last stable version: 0.7.14 alpha
 
  > Next Big Update: ASYNC & unicorn support
 
@@ -684,7 +685,7 @@ To test the web framework, PyTest with the pytest-cov plugin is used. You can lo
 ## Documentation 🌍
 The main documentation is [here](https://alexeev-prog.github.io/pyEchoNext/).
 
- > At the moment documentation move from doxygen to sphinx
+<img src="https://github.com/alexeev-prog/pyEchoNext/actions/workflows/docs.yml/badge.svg">
 
 ## 💬 Support
 If you encounter any issues or have questions about pyEchoNext, please:

SECURITY.md

@@ -7,12 +7,13 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 0.7.14  | :white_check_mark: |
 | 0.7.13  | :white_check_mark: |
-| 0.7.12  | :white_check_mark: |
-| 0.7.11  | :white_check_mark: |
-| 0.6.11  | :white_check_mark: |
-| 0.6.10  | :white_check_mark: |
-| 0.6.9   | :white_check_mark: |
+| 0.7.12  | :x:                |
+| 0.7.11  | :x:                |
+| 0.6.11  | :x:                |
+| 0.6.10  | :x:                |
+| 0.6.9   | :x:                |
 | 0.5.9   | :x:                |
 | 0.5.8   | :x:                |
 | 0.5.7   | :x:                |

docs/index.rst

@@ -1,52 +1,3 @@
-.. pyEchoNext documentation master file, created by
-   sphinx-quickstart on Fri Apr 18 00:12:47 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-pyEchoNext documentation
-========================
-
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Article Docs:
-   
-   webframework_design
-   webapp_creation
-   routes_and_views
-   requests_responses
-   i18n_locales
-   security
-   mvc
-   permissions
-   
-
-------------------
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Source code docs:
-   
-   pyechonext
-   pyechonext.app
-   pyechonext.middleware
-   pyechonext.permissions
-   pyechonext.request
-   pyechonext.response
-   pyechonext.static
-   pyechonext.urls
-   pyechonext.cache
-   pyechonext.config
-   pyechonext.apidoc_ui
-   pyechonext.auth
-   pyechonext.docsgen
-   pyechonext.i18n_l10n
-   pyechonext.logging
-   pyechonext.template_engine
-   pyechonext.utils
-
-------------------
-
 🌟 **EchoNext: The Future of Web** 🚀
 =====================================
 
@@ -57,6 +8,8 @@ pyEchoNext documentation
       <p align="center">
 
    EchoNext is a lightweight, fast and scalable web framework for Python
+   Explore the docs » Why Choose pyEchoNext · Key Features · Getting
+   Started · Basic Usage · Specification · Documentation · License
 
    .. raw:: html
 
@@ -70,15 +23,24 @@ pyEchoNext documentation
 
    </p>
 
+   EchoNext is a lightweight, fast and scalable web framework for Python
+
 ..
 
-   EchoNext is a lightweight, fast and scalable web framework for Python
+   [!CAUTION] At the moment, EchoNext is under active development, many
+   things may not work, and this version is not recommended for use (all
+   at your own risk)
 
 Welcome to **EchoNext**, where innovation meets simplicity! Are you
 tired of the sluggishness of traditional web frameworks? Want a solution
 that keeps pace with your ambitious apps? Look no further. EchoNext is
 your agile companion in the world of web development!
 
+   [!NOTE] Versions below 0.7.14a are not recommended for use with
+   gunicorn <23.0 due to the fact that they used an older version of
+   gunicorn (<23.0), which was
+   `vulnerable <https://deps.dev/advisory/osv/GHSA-hc5x-x2vx-497g>`__.
+
 .. raw:: html
 
    <p align="center">
@@ -91,7 +53,7 @@ your agile companion in the world of web development!
 web applications with lightning speed and flexibility. With EchoNext,
 you’re not just coding; you’re building a masterpiece!
 
-   Last stable version: 0.7.13 alpha
+   Last stable version: 0.7.14 alpha
 
 ..
 
@@ -237,13 +199,19 @@ detailed usage examples and API reference.
    </p>
 
 ⚙️ Dependency Injection
---------------------
+-----------------------
 
 pyEchoNext is universal, and you are free to use any
 Dependency-Injection framework. But we recommend using the specially
 developed `echonextdi <https://github.com/alexeev-prog/echonext_di>`__.
 It is simple and fast to use.
 
+Install:
+
+.. code:: bash
+
+   pip install echonextdi
+
 Example code:
 
 .. code:: python
@@ -275,6 +243,8 @@ Example code:
 💻 Usage Examples
 -----------------
 
+You can view examples at `examples directory <./examples>`__.
+
 Basic With Depends Injection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -433,6 +403,8 @@ Permissions
 FullApp with locale, static files, docs generation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Also see in `examples <./examples/example_locale.py>`__
+
 .. code:: python
 
    from pyechonext.apidoc_ui import APIDocUI, APIDocumentation
@@ -821,8 +793,6 @@ Documentation 🌍
 The main documentation is
 `here <https://alexeev-prog.github.io/pyEchoNext/>`__.
 
-   At the moment documentation move from doxygen to sphinx
-   
 💬 Support
 ----------
 
@@ -946,4 +916,4 @@ General Public License for more details.
 
 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation,
-Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

poetry.lock

@@ -9,7 +9,6 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = ">=3.11,<4.0"
 rich = "^13.8"
-loguru = "^0.7.0"
 gunicorn = "^23.0"
 pysocks = "^1.7"
 parse = "^1.20"