Helper layer for apis development with Python and Flask
Project description
ZPy Core, Layer for build microservices
ZPy Core
Zurck'z Py Flask Micro Services Core
This package contains some helpers features for build python microservices using Flask framework
ZPy use the following packages:
- Flask
- marshmallow
- marshmallow_objects
- requests
- aws-lambda-wsgi
Requirements
- Python 3.6+
Installation
Use the package manager pip to install py flask micro service core .
pip install zpy-api-core
Features
Contains some helper features.
- Api
- Api Builder
- Response Builder
- Models
- Hooks
- Middlewares
- Exceptions
- Cloud Implementations
- Aws Handler decorators
- See: AWS Package
- CLI
- DDD Project structure generator
- Bounded Context Generator
- UseCases generator
- Database
- Logger
- Stream
- Utils
- Collections
- element finder
- Dates
- Time zones
- Transforms
- Ciphers
- Functions
- Parallel
- map parallel
- run parallel
- Objects
- gzip
- Collections
Basic Usage
Generate project using zpy CLI
# Generate project with basic information. for more type: zpy --help
zpy make -p awesome-api -d "My awsome users api" -c Users -uc UserSearcher -op
...
cd awesome-api
zpy will generate the project with the following structure
awesome-api
│ .env
│ .gitignore
│ CHANGELOG.md
│ CHANGELOG.md
│ README.md
│ requirements.txt
│
└───src
│ │ di.py
│ │ handler.py
│ │ local_deploy.py
│ │
│ └───┬api
│ │ routes.py
│ │ ...
│ └contexts
│ │ ...
│ └───users
│ │ ...
│ └───┬application
│ │ │ ...
│ └───┬domain
│ │ │ ...
│ └───┬infraestructure
│ │ ...
└───tests
│ user_searcher_test.py
Dependencies file
# 🛸 Generated by zPy
from zpy.utils import get_env_or_throw as var
from zpy.app.usecase import UseCase
from typing import Any
# * Setup Dependencies 📃
from contexts.users.domain.repositories import UserRepository
from contexts.users.infraestructure.payment_repository import AwesomeUserRepository
from contexts.users.application.user_searcher import UserSearcher
repository: UserRepository = AwesomeUserRepository()
# Setup UseCases
user_searcher_uc: UseCase[Any, None] = UserSearcher(repository)
print("🚀 Dependencies loaded successfully...")
routes.py
# 🛸 Generated by zPy
from di import user_searcher_uc
from flask import Flask
from zpy.api.http.response import response_builder
from zpy.api.flask import create_app
app: Flask = create_app()
@app.route("/api/users", methods=["GET"])
@response_builder
def users():
return user_searcher_uc.execute(None)
Use Case
# 🛸 Generated by zPy
from typing import Any
from zpy.app.usecase import UseCase
from ..domain.repositories import UserRepository
class UserSearcher(UseCase[Any, Any]):
"""
Use Case description.
"""
def __init__(self, repository: PaymentRepository) -> None:
self.repository = repository
def execute(self, data: Any, *args, **kwargs) -> None:
# TODO Do magic with business rules 😁
return self.repository.user_searcher(data)
Local Dev Deploy
# 🛸 Generated by zPy
from dotenv import load_dotenv
load_dotenv(
dotenv_path="|3:\\projects\\demos\\awesome-api\\.env"
)
from api.routes import app
if __name__ == "__main__":
app.run(host="127.0.0.1", port=5050, debug=True)
handler.py configure for aws lambda and api gateway
# 🛸 Generated by zPy
from zpy.api.flask.cloud_handlers import aws_lambda
from api.routes import app
import aws_lambda_wsgi as awsgi
@aws_lambda()
def handle(event: dict, context: dict) -> any:
return awsgi.response(app, event, context)
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
Authors
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
Built Distribution
Hashes for zpy_api_core-1.0.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd9c225cdebc26de84565b0c880e1c069124e49dfeebf67cdcff966cd6e5171b |
|
MD5 | 37eec026918cdc710e76982c246dd59b |
|
BLAKE2b-256 | c65022cae27ed8d8bd8f1abfc821a0cad7f42f5aec90ffb8800d957be5a70681 |