panther 3.3.1__tar.gz → 4.1.3__tar.gz

panther-4.1.3/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.1
+Name: panther
+Version: 4.1.3
+Summary: Fast &  Friendly, Web Framework For Building Async APIs
+Home-page: https://github.com/alirn76/panther
+Author: Ali RajabNezhad
+Author-email: alirn76@yahoo.com
+License: BSD-3-Clause license
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httptools~=0.6
+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: 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~=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)
+
+
+## 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 Framework** 
+---
+
+### 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>
+
+---
+
+### 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_
+
+- #### 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-4.1.3/README.md

@@ -0,0 +1,173 @@
+
+[![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 Framework** 
+---
+
+### 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>
+
+---
+
+### 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_
+
+- #### 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.3.1 → panther-4.1.3}/panther/__init__.py

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

panther-4.1.3/panther/_load_configs.py

@@ -0,0 +1,263 @@
+import logging
+import sys
+from importlib import import_module
+from multiprocessing import Manager
+
+from panther._utils import import_class
+from panther.background_tasks import background_tasks
+from panther.base_websocket import WebsocketConnections
+from panther.cli.utils import import_error
+from panther.configs import JWTConfig, config
+from panther.db.connections import redis
+from panther.db.queries.mongodb_queries import BaseMongoDBQuery
+from panther.db.queries.pantherdb_queries import BasePantherDBQuery
+from panther.exceptions import PantherError
+from panther.middlewares.base import WebsocketMiddleware, HTTPMiddleware
+from panther.panel.urls import urls as panel_urls
+from panther.routings import finalize_urls, flatten_urls
+
+__all__ = (
+    'load_configs_module',
+    'load_redis',
+    'load_startup',
+    'load_shutdown',
+    'load_timezone',
+    'load_database',
+    'load_secret_key',
+    'load_monitoring',
+    'load_throttling',
+    'load_user_model',
+    'load_log_queries',
+    'load_middlewares',
+    'load_auto_reformat',
+    'load_background_tasks',
+    'load_default_cache_exp',
+    'load_authentication_class',
+    'load_urls',
+    'load_websocket_connections',
+)
+
+logger = logging.getLogger('panther')
+
+
+def load_configs_module(module_name: str, /) -> dict:
+    """Read the config file as dict"""
+    if module_name:
+        _module = sys.modules[module_name]
+    else:
+        try:
+            _module = import_module('core.configs')
+        except ModuleNotFoundError:
+            raise _exception_handler(field='core/configs.py', error='Not Found')
+    return _module.__dict__
+
+
+def load_redis(_configs: dict, /) -> None:
+    if redis_config := _configs.get('REDIS'):
+        # Check redis module installation
+        try:
+            from redis.asyncio import Redis
+        except ImportError as e:
+            raise import_error(e, package='redis')
+        redis_class_path = redis_config.get('class', 'panther.db.connections.RedisConnection')
+        redis_class = import_class(redis_class_path)
+        # We have to create another dict then pop the 'class' else we can't pass the tests
+        args = redis_config.copy()
+        args.pop('class', None)
+        redis_class(**args, init=True)
+
+
+def load_startup(_configs: dict, /) -> None:
+    if startup := _configs.get('STARTUP'):
+        config.STARTUP = import_class(startup)
+
+
+def load_shutdown(_configs: dict, /) -> None:
+    if shutdown := _configs.get('SHUTDOWN'):
+        config.SHUTDOWN = import_class(shutdown)
+
+
+def load_timezone(_configs: dict, /) -> None:
+    if timezone := _configs.get('TIMEZONE'):
+        config.TIMEZONE = timezone
+
+
+def load_database(_configs: dict, /) -> None:
+    database_config = _configs.get('DATABASE', {})
+    if 'engine' in database_config:
+        if 'class' not in database_config['engine']:
+            raise _exception_handler(field='DATABASE', error=f'`engine["class"]` not found.')
+
+        engine_class_path = database_config['engine']['class']
+        engine_class = import_class(engine_class_path)
+        # We have to create another dict then pop the 'class' else we can't pass the tests
+        args = database_config['engine'].copy()
+        args.pop('class')
+        config.DATABASE = engine_class(**args)
+
+        if engine_class_path == 'panther.db.connections.PantherDBConnection':
+            config.QUERY_ENGINE = BasePantherDBQuery
+        elif engine_class_path == 'panther.db.connections.MongoDBConnection':
+            config.QUERY_ENGINE = BaseMongoDBQuery
+
+    if 'query' in database_config:
+        if config.QUERY_ENGINE:
+            logger.warning('`DATABASE.query` has already been filled.')
+        config.QUERY_ENGINE = import_class(database_config['query'])
+
+
+def load_secret_key(_configs: dict, /) -> None:
+    if secret_key := _configs.get('SECRET_KEY'):
+        config.SECRET_KEY = secret_key.encode()
+
+
+def load_monitoring(_configs: dict, /) -> None:
+    if _configs.get('MONITORING'):
+        config.MONITORING = True
+
+
+def load_throttling(_configs: dict, /) -> None:
+    if throttling := _configs.get('THROTTLING'):
+        config.THROTTLING = throttling
+
+
+def load_user_model(_configs: dict, /) -> None:
+    config.USER_MODEL = import_class(_configs.get('USER_MODEL', 'panther.db.models.BaseUser'))
+    config.MODELS.append(config.USER_MODEL)
+
+
+def load_log_queries(_configs: dict, /) -> None:
+    if _configs.get('LOG_QUERIES'):
+        config.LOG_QUERIES = True
+
+
+def load_middlewares(_configs: dict, /) -> None:
+    from panther.middlewares import BaseMiddleware
+
+    middlewares = {'http': [], 'ws': []}
+
+    # Collect Middlewares
+    for middleware in _configs.get('MIDDLEWARES') or []:
+        if not isinstance(middleware, list | tuple):
+            raise _exception_handler(field='MIDDLEWARES', error=f'{middleware} should have 2 part: (path, kwargs)')
+
+        if len(middleware) == 1:
+            path = middleware[0]
+            data = {}
+
+        elif len(middleware) > 2:
+            raise _exception_handler(field='MIDDLEWARES', error=f'{middleware} too many arguments')
+
+        else:
+            path, data = middleware
+
+        try:
+            middleware_class = import_class(path)
+        except (AttributeError, ModuleNotFoundError):
+            raise _exception_handler(field='MIDDLEWARES', error=f'{path} is not a valid middleware path')
+
+        if issubclass(middleware_class, BaseMiddleware) is False:
+            raise _exception_handler(field='MIDDLEWARES', error='is not a sub class of BaseMiddleware')
+
+        if middleware_class.__bases__[0] in (BaseMiddleware, HTTPMiddleware):
+            middlewares['http'].append((middleware_class, data))
+
+        if middleware_class.__bases__[0] in (BaseMiddleware, WebsocketMiddleware):
+            middlewares['ws'].append((middleware_class, data))
+
+    config.HTTP_MIDDLEWARES = middlewares['http']
+    config.WS_MIDDLEWARES = middlewares['ws']
+
+
+def load_auto_reformat(_configs: dict, /) -> None:
+    if _configs.get('AUTO_REFORMAT'):
+        config.AUTO_REFORMAT = True
+
+
+def load_background_tasks(_configs: dict, /) -> None:
+    if _configs.get('BACKGROUND_TASKS'):
+        config.BACKGROUND_TASKS = True
+        background_tasks.initialize()
+
+
+def load_default_cache_exp(_configs: dict, /) -> None:
+    if default_cache_exp := _configs.get('DEFAULT_CACHE_EXP'):
+        config.DEFAULT_CACHE_EXP = default_cache_exp
+
+
+def load_authentication_class(_configs: dict, /) -> None:
+    """Should be after `load_secret_key()`"""
+    if authentication := _configs.get('AUTHENTICATION'):
+        config.AUTHENTICATION = import_class(authentication)
+
+    if ws_authentication := _configs.get('WS_AUTHENTICATION'):
+        config.WS_AUTHENTICATION = import_class(ws_authentication)
+
+    load_jwt_config(_configs)
+
+
+def load_jwt_config(_configs: dict, /) -> None:
+    """Only Collect JWT Config If Authentication Is JWTAuthentication"""
+    auth_is_jwt = (
+            getattr(config.AUTHENTICATION, '__name__', None) == 'JWTAuthentication' or
+            getattr(config.WS_AUTHENTICATION, '__name__', None) == 'QueryParamJWTAuthentication'
+    )
+    jwt = _configs.get('JWTConfig', {})
+    if auth_is_jwt or jwt:
+        if 'key' not in jwt:
+            if config.SECRET_KEY is None:
+                raise _exception_handler(field='JWTConfig', error='`JWTConfig.key` or `SECRET_KEY` is required.')
+            jwt['key'] = config.SECRET_KEY.decode()
+        config.JWT_CONFIG = JWTConfig(**jwt)
+
+
+def load_urls(_configs: dict, /, urls: dict | None) -> None:
+    """
+    Return tuple of all urls (as a flat dict) and (as a nested dict)
+    """
+    if isinstance(urls, dict):
+        pass
+
+    elif (url_routing := _configs.get('URLs')) is None:
+        raise _exception_handler(field='URLs', error='required.')
+
+    elif isinstance(url_routing, dict):
+        error = (
+            "can't be 'dict', you may want to pass it's value directly to Panther(). " 'Example: Panther(..., urls=...)'
+        )
+        raise _exception_handler(field='URLs', error=error)
+
+    elif not isinstance(url_routing, str):
+        error = 'should be dotted string.'
+        raise _exception_handler(field='URLs', error=error)
+
+    else:
+        try:
+            urls = import_class(url_routing)
+        except ModuleNotFoundError as e:
+            raise _exception_handler(field='URLs', error=e)
+
+        if not isinstance(urls, dict):
+            raise _exception_handler(field='URLs', error='should point to a dict.')
+
+    config.FLAT_URLS = flatten_urls(urls)
+    config.URLS = finalize_urls(config.FLAT_URLS)
+    config.URLS['_panel'] = finalize_urls(flatten_urls(panel_urls))
+
+
+def load_websocket_connections():
+    """Should be after `load_redis()`"""
+    if config.HAS_WS:
+        # Check `websockets`
+        try:
+            import websockets
+        except ImportError as e:
+            raise import_error(e, package='websockets')
+
+        # Use the redis pubsub if `redis.is_connected`, else use the `multiprocessing.Manager`
+        pubsub_connection = redis.create_connection_for_websocket() if redis.is_connected else Manager()
+        config.WEBSOCKET_CONNECTIONS = WebsocketConnections(pubsub_connection=pubsub_connection)
+
+
+def _exception_handler(field: str, error: str | Exception) -> PantherError:
+    return PantherError(f"Invalid '{field}': {error}")