Skip to main content

Fast & Friendly, Web Framework For Building Async APIs

Project description

PyPI PyVersion codecov Downloads license

Panther

Is A Fast & Friendly Web Framework For Building Async APIs With Python 3.10+

logo

📚 Full Documentation: PantherPy.GitHub.io


Why Use Panther ?

  • Include Simple File-Base Database (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 (Benchmark)

Supported by

jetbrains

Installation

$ pip install panther

Usage

  • Create Project

    $ panther create
    
  • Run Project

    $ panther run --reload
    

    * Panther uses Uvicorn as ASGI (Asynchronous Server Gateway Interface) but you can run the project with Granian, daphne or any ASGI server

  • Monitoring Requests

    $ panther monitor 
    
  • Python Shell

    $ panther shell
    

API Example

  • Create main.py

    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/

WebSocket Echo Example

  • Create main.py

    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/ and work with your websocket

Next Step: First CRUD


How Panther Works!

diagram


Roadmap

roadmap


If you find this project useful, please give it a star ⭐️.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

panther-4.3.6.tar.gz (75.8 kB view details)

Uploaded Source

Built Distribution

panther-4.3.6-py3-none-any.whl (67.8 kB view details)

Uploaded Python 3

File details

Details for the file panther-4.3.6.tar.gz.

File metadata

  • Download URL: panther-4.3.6.tar.gz
  • Upload date:
  • Size: 75.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for panther-4.3.6.tar.gz
Algorithm Hash digest
SHA256 9f2d650dabf6ffa8d1ba0c4c2ae022474e4afd84bb4badfae01e4b6ea85c030a
MD5 c69911b00a2532ab76c5194c72adbd70
BLAKE2b-256 dda6cd5169de3d81e19e2028f9f742c798e8e6e69da3212c55b5b481f064a187

See more details on using hashes here.

File details

Details for the file panther-4.3.6-py3-none-any.whl.

File metadata

  • Download URL: panther-4.3.6-py3-none-any.whl
  • Upload date:
  • Size: 67.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for panther-4.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3c8881dc8f37dee5230a423c4bf172d8cfccfb92693d41525fd1c9ba93f8d5f9
MD5 fc01dd4e28f689def5db67a2838e475f
BLAKE2b-256 c32c354d778c421e5f3e6893371ef9b61153f9eb60d7042bcd618fe378cbd681

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page