panther 3.9.0__tar.gz → 4.0.1__tar.gz

{panther-3.9.0 → panther-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: panther
-Version: 3.9.0
+Version: 4.0.1
 Summary: Fast &  Friendly, Web Framework For Building Async APIs
 Home-page: https://github.com/alirn76/panther
 Author: Ali RajabNezhad
@@ -13,21 +13,21 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bson~=0.5
 Requires-Dist: httptools~=0.6
-Requires-Dist: pantherdb==1.3.5
-Requires-Dist: pydantic~=2.1
-Requires-Dist: rich~=13.5
-Requires-Dist: uvicorn~=0.23
-Requires-Dist: watchfiles~=0.19
+Requires-Dist: pantherdb==2.1.0
+Requires-Dist: pydantic~=2.6
+Requires-Dist: rich~=13.7
+Requires-Dist: uvicorn~=0.27
+Requires-Dist: pytz~=2024.1
 Provides-Extra: full
 Requires-Dist: redis==5.0.1; extra == "full"
-Requires-Dist: pymongo~=4.4; extra == "full"
+Requires-Dist: motor~=3.3; extra == "full"
 Requires-Dist: bpython~=0.24; extra == "full"
 Requires-Dist: ruff~=0.1.9; extra == "full"
 Requires-Dist: python-jose~=3.3; extra == "full"
 Requires-Dist: websockets~=12.0; extra == "full"
-Requires-Dist: cryptography~=41.0; extra == "full"
+Requires-Dist: cryptography~=42.0; extra == "full"
+Requires-Dist: watchfiles~=0.21.0; extra == "full"
 
 
 [![PyPI](https://img.shields.io/pypi/v/panther?label=PyPI)](https://pypi.org/project/panther/) [![PyVersion](https://img.shields.io/pypi/pyversions/panther.svg)](https://pypi.org/project/panther/) [![codecov](https://codecov.io/github/AliRn76/panther/graph/badge.svg?token=YWFQA43GSP)](https://codecov.io/github/AliRn76/panther) [![Downloads](https://static.pepy.tech/badge/panther/month)](https://pepy.tech/project/panther) [![license](https://img.shields.io/github/license/alirn76/panther.svg)](https://github.com/alirn76/panther/blob/main/LICENSE)
@@ -45,14 +45,18 @@ Requires-Dist: cryptography~=41.0; extra == "full"
 ---
 
 ### Why Use Panther ?
-- Document-oriented Databases ODM ([PantherDB](https://pypi.org/project/pantherdb/), MongoDB)
-- Built-in Websocket Support
-- Cache APIs (In Memory, In Redis)
-- Built-in Authentication Classes (Customizable)
-- Built-in Permission Classes (Customizable)
-- Handle Custom Middlewares
-- Handle Custom Throttling 
-- Visual API Monitoring (In Terminal)
+- Include Simple **File-Base** Database ([PantherDB](https://pypi.org/project/pantherdb/))
+- Built-in Document-oriented Databases **ODM** (**MongoDB**, PantherDB)
+- Built-in **Websocket** Support
+- Built-in API **Caching** System (In Memory, **Redis**)
+- Built-in **Authentication** Classes
+- Built-in **Permission** Classes
+- Built-in Visual API **Monitoring** (In Terminal)
+- Support Custom **Background Tasks**
+- Support Custom **Middlewares**
+- Support Custom **Throttling**
+- Support **Function-Base** and **Class-Base** APIs
+- It's One Of The **Fastest Python Frameworks** 
 ---
 
 ### Supported by
@@ -84,111 +88,129 @@ Requires-Dist: cryptography~=41.0; extra == "full"
 ---
 
 ### Installation
-- <details>
-    <summary>1. Create a Virtual Environment</summary>
-    <pre>$ python3 -m venv .venv</pre>
-  
-  </details>
-  
-- <details>
-    <summary>2. Active The Environment</summary>
-    * Linux & Mac
-      <pre>$ source .venv/bin/activate</pre>
-    * Windows
-      <pre>$ .\.venv\Scripts\activate</pre>
-  
-  </details>
-
-- <details open>
-    <summary>3. <b>Install Panther</b></summary>
-    - ⬇ Normal Installation
-      <pre><b>$ pip install panther</b></pre>
-    -  ⬇ Include full requirements (MongoDB, JWTAuth, Ruff, Redis, bpython)
-      <pre>$ pip install panther[full]</pre>
-  </details>
-  
----
+```shell
+$ pip install panther
+```
 
 ### Usage
 
 - #### Create Project
 
-    ```console
+    ```shell
     $ panther create
     ```
 
 - #### Run Project
     
-    ```console
+    ```shell
     $ panther run --reload
     ```
   _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server too_
 
 - #### Monitoring Requests
 
-    ```console
+    ```shell
     $ panther monitor 
     ```
 
 - #### Python Shell
 
-    ```console
+    ```shell
     $ panther shell
     ```
   
 ---
 
-### Single-File Structure Example
+### API Example
   - Create `main.py`
 
     ```python
     from datetime import datetime, timedelta
     
-    from panther import version, status, Panther
-    from panther.app import API
-    from panther.request import Request
+    from panther import status, Panther
+    from panther.app import GenericAPI
     from panther.response import Response
-    from panther.throttling import Throttling
     
-    InfoThrottling = Throttling(rate=5, duration=timedelta(minutes=1))
     
+    class FirstAPI(GenericAPI):
+        # Cache Response For 10 Seconds
+        cache = True
+        cache_exp_time = timedelta(seconds=10)
+        
+        def get(self):
+            date_time = datetime.now().isoformat()
+            data = {'detail': f'Hello World | {date_time}'}
+            return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
     
-    @API()
-    async def hello_world():
-        return {'detail': 'Hello World'}
+    
+    url_routing = {'': FirstAPI}
+    app = Panther(__name__, configs=__name__, urls=url_routing)
+    ```
+
+  - Run the project:
+    - `$ panther run --reload` 
+  
+  - Checkout the [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
+
+### WebSocket Echo Example 
+  - Create `main.py`
+
+    ```python
+    from panther import Panther
+    from panther.app import GenericAPI
+    from panther.response import HTMLResponse
+    from panther.websocket import GenericWebsocket
     
     
-    @API(cache=True, throttling=InfoThrottling)
-    async def info(request: Request):
-        data = {
-            'panther_version': version(),
-            'datetime_now': datetime.now().isoformat(),
-            'user_agent': request.headers.user_agent
-        }
-        return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
+    class FirstWebsocket(GenericWebsocket):
+        async def connect(self, **kwargs):
+            await self.accept()
     
+        async def receive(self, data: str | bytes):
+            await self.send(data)
+    
+    
+    class MainPage(GenericAPI):
+        def get(self):
+            template = """
+            <input type="text" id="messageInput">
+            <button id="sendButton">Send Message</button>
+            <ul id="messages"></ul>
+            <script>
+                var socket = new WebSocket('ws://127.0.0.1:8000/ws');
+                socket.addEventListener('message', function (event) {
+                    var li = document.createElement('li');
+                    document.getElementById('messages').appendChild(li).textContent = 'Server: ' + event.data;
+                });
+                function sendMessage() {
+                    socket.send(document.getElementById('messageInput').value);
+                }
+                document.getElementById('sendButton').addEventListener('click', sendMessage);
+            </script>
+            """
+            return HTMLResponse(template)
     
     url_routing = {
-        '': hello_world,
-        'info': info,
+        '': MainPage,
+        'ws': FirstWebsocket,
     }
-    
     app = Panther(__name__, configs=__name__, urls=url_routing)
+
     ```
 
   - Run the project:
     - `$ panther run --reload` 
-  
-
-  - Now you can see these two urls:</b>
-    - [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
-    - [http://127.0.0.1:8000/info/](http://127.0.0.1:8000/info/)
+  - Go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) and work with your `websocket`
 
 
 
 > **Next Step: [First CRUD](https://pantherpy.github.io/function_first_crud)**
 
-> **Real Word Example: [Https://GitHub.com/PantherPy/panther-example](https://GitHub.com/PantherPy/panther-example)**
+---
+
+### How Panther Works!
+
+![diagram](https://raw.githubusercontent.com/AliRn76/panther/master/docs/docs/images/diagram.png)
 
 ---
 

panther-4.0.1/README.md

@@ -0,0 +1,192 @@
+
+[![PyPI](https://img.shields.io/pypi/v/panther?label=PyPI)](https://pypi.org/project/panther/) [![PyVersion](https://img.shields.io/pypi/pyversions/panther.svg)](https://pypi.org/project/panther/) [![codecov](https://codecov.io/github/AliRn76/panther/graph/badge.svg?token=YWFQA43GSP)](https://codecov.io/github/AliRn76/panther) [![Downloads](https://static.pepy.tech/badge/panther/month)](https://pepy.tech/project/panther) [![license](https://img.shields.io/github/license/alirn76/panther.svg)](https://github.com/alirn76/panther/blob/main/LICENSE)
+
+
+## Panther 
+<b>Is A Fast &  Friendly Web Framework For Building Async APIs With Python 3.10+</b> 
+
+<p align="center">
+  <img src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/logo-vertical.png" alt="logo" style="width: 450px">
+</p>
+
+**_📚 Full Documentation:_** [PantherPy.GitHub.io](https://pantherpy.github.io)
+
+---
+
+### Why Use Panther ?
+- Include Simple **File-Base** Database ([PantherDB](https://pypi.org/project/pantherdb/))
+- Built-in Document-oriented Databases **ODM** (**MongoDB**, PantherDB)
+- Built-in **Websocket** Support
+- Built-in API **Caching** System (In Memory, **Redis**)
+- Built-in **Authentication** Classes
+- Built-in **Permission** Classes
+- Built-in Visual API **Monitoring** (In Terminal)
+- Support Custom **Background Tasks**
+- Support Custom **Middlewares**
+- Support Custom **Throttling**
+- Support **Function-Base** and **Class-Base** APIs
+- It's One Of The **Fastest Python Frameworks** 
+---
+
+### Supported by
+<center>
+    <a href="https://drive.google.com/file/d/17xe1hicIiRF7SQ-clg9SETdc19SktCbV/view?usp=sharing">
+      <img alt="jetbrains" src="https://github.com/AliRn76/panther/raw/master/docs/docs/images/jb_beam_50x50.png">
+    </a>
+</center>
+
+---
+
+### Benchmark
+
+| Framework  | Throughput (Request/Second) |
+|------------|-----------------------------|
+| Blacksheep | 5,339                       |
+| Muffin     | 5,320                       |
+| Panther    | 5,112                       |
+| Sanic      | 3,660                       |
+| FastAPI    | 3,260                       |
+| Tornado    | 2,081                       |
+| Bottle     | 2,045                       |
+| Django     | 821                         |
+| Flask      | 749                         |
+
+
+> **More Detail:** https://GitHub.com/PantherPy/frameworks-benchmark
+
+---
+
+### Installation
+```shell
+$ pip install panther
+```
+
+### Usage
+
+- #### Create Project
+
+    ```shell
+    $ panther create
+    ```
+
+- #### Run Project
+    
+    ```shell
+    $ panther run --reload
+    ```
+  _* Panther uses [Uvicorn](https://github.com/encode/uvicorn) as ASGI (Asynchronous Server Gateway Interface) but you can run the project with [Granian](https://pypi.org/project/granian/), [daphne](https://pypi.org/project/daphne/) or any ASGI server too_
+
+- #### Monitoring Requests
+
+    ```shell
+    $ panther monitor 
+    ```
+
+- #### Python Shell
+
+    ```shell
+    $ panther shell
+    ```
+  
+---
+
+### API Example
+  - Create `main.py`
+
+    ```python
+    from datetime import datetime, timedelta
+    
+    from panther import status, Panther
+    from panther.app import GenericAPI
+    from panther.response import Response
+    
+    
+    class FirstAPI(GenericAPI):
+        # Cache Response For 10 Seconds
+        cache = True
+        cache_exp_time = timedelta(seconds=10)
+        
+        def get(self):
+            date_time = datetime.now().isoformat()
+            data = {'detail': f'Hello World | {date_time}'}
+            return Response(data=data, status_code=status.HTTP_202_ACCEPTED)
+    
+    
+    url_routing = {'': FirstAPI}
+    app = Panther(__name__, configs=__name__, urls=url_routing)
+    ```
+
+  - Run the project:
+    - `$ panther run --reload` 
+  
+  - Checkout the [http://127.0.0.1:8000/](http://127.0.0.1:8000/)
+
+### WebSocket Echo Example 
+  - Create `main.py`
+
+    ```python
+    from panther import Panther
+    from panther.app import GenericAPI
+    from panther.response import HTMLResponse
+    from panther.websocket import GenericWebsocket
+    
+    
+    class FirstWebsocket(GenericWebsocket):
+        async def connect(self, **kwargs):
+            await self.accept()
+    
+        async def receive(self, data: str | bytes):
+            await self.send(data)
+    
+    
+    class MainPage(GenericAPI):
+        def get(self):
+            template = """
+            <input type="text" id="messageInput">
+            <button id="sendButton">Send Message</button>
+            <ul id="messages"></ul>
+            <script>
+                var socket = new WebSocket('ws://127.0.0.1:8000/ws');
+                socket.addEventListener('message', function (event) {
+                    var li = document.createElement('li');
+                    document.getElementById('messages').appendChild(li).textContent = 'Server: ' + event.data;
+                });
+                function sendMessage() {
+                    socket.send(document.getElementById('messageInput').value);
+                }
+                document.getElementById('sendButton').addEventListener('click', sendMessage);
+            </script>
+            """
+            return HTMLResponse(template)
+    
+    url_routing = {
+        '': MainPage,
+        'ws': FirstWebsocket,
+    }
+    app = Panther(__name__, configs=__name__, urls=url_routing)
+
+    ```
+
+  - Run the project:
+    - `$ panther run --reload` 
+  - Go to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) and work with your `websocket`
+
+
+
+> **Next Step: [First CRUD](https://pantherpy.github.io/function_first_crud)**
+
+---
+
+### How Panther Works!
+
+![diagram](https://raw.githubusercontent.com/AliRn76/panther/master/docs/docs/images/diagram.png)
+
+---
+
+### Roadmap
+
+![roadmap](https://raw.githubusercontent.com/AliRn76/panther/master/docs/docs/images/roadmap.jpg)
+
+---
+
+**If you find this project useful, please give it a star ⭐️.**

{panther-3.9.0 → panther-4.0.1}/panther/__init__.py

@@ -1,6 +1,6 @@
 from panther.main import Panther  # noqa: F401
 
-__version__ = '3.9.0'
+__version__ = '4.0.1'
 
 
 def version():