Skip to main content

A python framework to create api applications.

Project description

Zunzun Framework

Zunzun is a Python framework that uses other libraries to implement its features. Ones of them are:

  • injector It's used to Dependency Injection.
  • click For creating commands line interface.
  • blinker Provides a fast dispatching system.
  • SQLAlchemy The Python SQL Toolkit and Object Relational Mapper.

Create an application

  1. Clone the example application from https://github.com/aprezcuba24/zunzun_app
  2. Create .env file base on .env.example
    • Configure database configuration
  3. You can use vscode to open the application in a container.
  4. Star the application using this command.
python manage.py core runserver
  1. Open the browser in this url http://localhost:8001/

Controller

We can create two types of controller, a function controller, or a class controller.

Function controller

from main import router


@router.post("/")
def register():
    return "Register"

Class controller

To create a class controller we can use the following command

python zunzun.py maker controller Role --route="/role"

Where "Role" will be the name of the controller and "/role" the path to access the controller.

The command will generate the file app/controllers/role.py

from zunzun import Response
from main import router

class RoleController:
    @router.get('/role')
    def index(self):
        return "RoleController Index"

In the class controller or in the function controller we can inject dependencies. For example, if we have a service named "PaypalService" we can inject it, with the following code.

from main import router
from app.services import PaypalService


@router.post("/")
def register(paypal: PaypalService):
    paypal.call_a_method()
    return "Register"

In a controller class, we can inject dependencies in the constructor or in any function.

from zunzun import Response
from main import router
from app.services import PaypalService, SomeService

class RoleController:
    def __init__(self, some_service: SomeService):
        self.some_service = some_service

    @router.get('/role')
    def index(self, paypal: PaypalService):
        return "RoleController Index"

Commands

Commands allow us to implement command line features. To do that we can use the following command.

python manager.py maker command role

Where "role" will be the name of the command. This command will create the following file app/commands/role.py.

import click
from injector import singleton, inject
from zunzun import Command


@singleton
class roleCommand(Command):
    @inject
    def __init__(self):
        super().__init__("role")
        self.add_option("--some-option")
        self.add_argument("some-argument")

    def handle(self, some_option, some_argument):
        click.echo(
            f"roleCommand [some_argument: {some_argument}] [some_option: {some_option}]"
        )

To use the new command we can type the following in the console.

python manager.py app role "An argument value" --some-option="An option value"

Listener

The listener allows us to implement the Event-Dispatcher pattern. To create a new listener with its signal we can use the following command.

python manager.py maker listener Role Role

Where the first word "Role" will be the listener name and the second will be the signal name. The command will generate the following files:

  • Signal file app/signals/role.py
  • Listener file app/listeners/role.py

The signal file will have this code.

from zunzun import Signal
from injector import singleton


@singleton
class RoleSignal(Signal):
    pass

The listener file will have this code.

from injector import singleton


@singleton
class RoleListener:
    def __call__(self, sender, **kwargs):
        pass

Services

We can create classes to implement any logic that we need. For example to create a service to integrate Paypal we can use the following command.

python manager.py maker service Paypal

The command will create the file app/services/paypal.py with the following code.

from injector import singleton, inject


@singleton
class PaypalService:
    @inject
    def __init__(self):
        pass

ORM

Zunzun uses SQLAlchemy to implement the ORM features. The framework uses two type of classes.

  • The model represents a single row in the database.
  • The repository is a class to implement the queries to the database.

To create the model and its repository we can use the following command.

python manager.py orm model_create Role

The model will be

from zunzun import orm
from sqlalchemy import Column, Integer


class Role(orm.BaseModel):
    __tablename__ = "Role"
    id = Column(Integer, primary_key=True)

The repository will be

from injector import singleton
from zunzun import orm
from app.model import Role


@singleton
class RoleRepository(orm.BaseRepository):
    def new(self, **kwargs):
        return Role(**kwargs)

Dependency injection

The framework uses this pattern to manage dependencies. To know how you can use see the documentation on inject

Project details


Download files

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

Source Distribution

zunzun-0.0.2.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

zunzun-0.0.2-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file zunzun-0.0.2.tar.gz.

File metadata

  • Download URL: zunzun-0.0.2.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for zunzun-0.0.2.tar.gz
Algorithm Hash digest
SHA256 75f51fe43f0f58b217662708c3376d42753ba11c8435e8a9ff2a21d776b1c3f8
MD5 f4a145b6cb807e005442be08492e6ff8
BLAKE2b-256 13220a94b65fd497e0a445dc02e8d3d75f3de954b6883259744b73a5a7a3bec8

See more details on using hashes here.

Provenance

File details

Details for the file zunzun-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: zunzun-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.4

File hashes

Hashes for zunzun-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 19f2a70463da2be4c95b5341a553c50f8873746d23b30e04cd1271fd62db35c0
MD5 601e9b034b66fc5f66ac636af749741a
BLAKE2b-256 1ea5b1c5bec45e3986ff0e5f9b64cace3d5eb61f3f7a32e2042ebde96d851e13

See more details on using hashes here.

Provenance

Supported by

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