Skip to main content

zemfrog

zemfrog logo https://img.shields.io/pypi/v/zemfrog.svg?style=for-the-badge https://img.shields.io/pypi/status/zemfrog.svg?style=for-the-badge https://img.shields.io/pypi/dm/zemfrog?logo=python&style=for-the-badge https://img.shields.io/travis/zemfrog/zemfrog.svg?style=for-the-badge Documentation Status

Zemfrog is a simple framework based on flask for building a REST API quickly. Which focuses on building a customizable, flexible and manageable REST API!

This project is heavily inspired by FastAPI and Django Framework.

Notes

The project is still in BETA version, which means that all the APIs in it are still unstable. Please be careful if you want to use it in a production environment! thanks.

Why zemfrog?

Zemfrog is equipped with advanced features including:

  • Solid application structure.

  • Automatically generate REST API.

  • Built-in JWT authentication.

  • RBAC support.

  • Automatically generate API documentation (swagger-ui).

  • Background jobs support.

  • Database migration based on application environment.

  • And much more…

Donate & Support

Keep in mind that donations are very important to me, because currently I am working alone to develop this project. It takes a lot of time and energy. If this project is useful, please give me any support. I really appreciate it.

And also you can donate your money via:

https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif https://c5.patreon.com/external/logo/become_a_patron_button.png https://ko-fi.com/img/githubbutton_sm.svg

Credits

History

1.0.0 (2020-09-03)

  • First release on PyPI.

1.0.1 (2020-09-07)

  • Automation create (CRUD) API

  • Update template API

  • Update zemfrog release information.

1.0.2 (2020-09-08)

  • Update API structure

1.0.3 (2020-09-08)

  • re-upload

1.0.4 (2020-09-09)

  • fix manifest file

1.0.5 (2020-09-10)

  • add command boilerplate

  • add schema command

1.0.6 (2020-09-15)

  • add jwt authentication

  • refactor blueprint boilerplate

  • add send async email

  • fix celery

1.0.7 (2020-09-19)

  • Fix: #8

  • flask-apispec integration.

  • improve authentication.

  • add default schema models.

  • Fix: rest api boilerplate

  • IMPROVE: Added a prompt if a schema model exists.

  • IMPROVE: add zemfrgo to requirements

  • DOC: add README to project boilerplate

1.0.8 (2020-10-03)

  • Fix: #12, #13, #14

  • IMPROVE: import the orm model in the schema generator.

  • General Update: update development status

1.0.9 (2020-10-05)

1.2.0 (2020-10-19)

  • NEW: add load urls

  • NEW: add load middlewares

  • NEW: middleware boilerplate.

  • NEW: multiple apps support

  • Fix minor bugs

1.2.1 (2020-10-27)

  • New Feature: added prompt to manage the app.

  • moved mail dir to templates/emails

  • add api_doc & authenticate decorator.

  • NEW: add swagger oauth2.

  • NEW: add first_name & last_name column.

  • IMPROVE: Support creating REST API descriptions via function documents.

  • Refactor Code: Rename and add field validation.

  • Code Change: update REST API structure.

1.2.2 (2020-10-28)

  • Refactor generator

  • New Feature: add error handler

1.2.3 (2020-11-13)

  • Adding: current_db local proxy

  • rename services directory to tasks

1.2.4 (2020-11-14)

  • support multiple static files

  • Add an endpoint to validate the password reset token

  • fix #37

1.2.5 (2020-11-18)

  • NEW: add extension, model, task generator

  • Refactor Code: add model mixin

  • add command user, role & permission

  • FIX: auth logs

  • New Feature: supports role-based access control

1.2.6 (2020-11-21)

  • IMPROVE: commands to manage nested applications

  • Added endpoint for checking token jwt

  • Add an endpoint to retrieve one data from the model

  • Add schema to limit results

  • Added a handler for handling API errors

1.2.7 (2020-11-24)

  • FIX: user checks in the test token endpoint

  • NEW: support for creating your own app loader

  • FIX: Make user roles optional

  • FIX: #49

2.0.1 (2020-12-20)

  • Refactoring app loaders

  • IMPROVE: REST API, models & validators

  • IMPROVE: added template checks

  • IMPROVE: add password validator

  • IMPROVE: Compatible with frontend nuxtjs

  • NEW: add flask-cors extension

2.0.2 (2020-12-20)

  • fix: missing flask-cors dependency

2.0.3 (2020-12-20)

  • IMPROVE: clean up dependencies

3.0.1 (2020-12-20)

  • add command secretkey

  • Fix: varchar length

  • Added db migration based on environment

  • Stable release

4.0.1 (2021-03-04)

  • IMPROVE: Move extensions to global

  • NEW: add pre-commit tool

  • IMPROVE: refactor json response

  • Refactor Code: run pre-commit

  • IMPROVE: Change ‘SystemExit’ to ‘ValidationError’

  • IMPROVE: Rename the api directory to apis

  • NEW: add autoflake hook

  • Changed the stable version status to BETA

4.0.2 (2021-03-05)

  • FIX: response message in jwt & error handler boilerplate

  • FIX: update zemfrog version in requirements.txt

4.0.3 (2021-03-17)

4.0.4 (2021-03-31)

  • FIX: role & permission relation

  • FIX: typo column name

  • IMPROVE: split blueprint and task to global

  • IMPROVE: split error handlers to global

  • IMPROVE: set default blueprint to blank

  • IMPROVE: Use schema from source rather than local proxy

  • IMPROVE: Using the model name corresponding user input

4.0.5 (2021-04-01)

  • FIX: Load the blueprint name

  • FIX: unknown column

  • NEW: added codecov workflow (testing)

  • NEW: add default value to ‘confirmed’ column

5.0.1 (2021-04-10)

  • Flask-smorest integration. Based on #63

  • Refactor Code: added scaffolding

  • FIX: use ‘alt_response’ instead of ‘response’ to wrap multiple responses.

  • FIX: configuration to enable / disable OpenAPI

  • IMPROVE: no longer supports to load main urls

  • IMPROVE: Add a command description to the sub application

  • IMPROVE: use ‘subprocess.call’ instead of ‘os.system’

  • Change the name of the password reset request template

  • create pyup.io config file

Metadata

Release files for zemfrog 5.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for zemfrog 5.0.1
File Size Uploaded Provenance Actions
zemfrog-5.0.1.tar.gz 85.6 kB Without provenance Details for zemfrog-5.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zemfrog 5.0.1
File Interpreter ABI Platform Actions
zemfrog-5.0.1-py2.py3-none-any.whl Python 3, Python 2 none any Details for zemfrog-5.0.1-py2.py3-none-any.whl

Total release size: 131.4 kB

Release files / zemfrog-5.0.1.tar.gz

Download URL zemfrog-5.0.1.tar.gz
Size 85.6 kB
Tags Source
SHA-256 checksum
How to use checksums
aa00dd996b20df6033ad6b66b799725dcd6e4fcb2f6969b4ffa1158001a8e2b2
BLAKE2b-256 checksum
How to use checksums
8fea5f98358c07eb79040cbf205ab7e35c0e9f82ff86a8fab0abd6620f8dbd82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Release files / zemfrog-5.0.1-py2.py3-none-any.whl

Download URL zemfrog-5.0.1-py2.py3-none-any.whl
Size 45.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f23f13f3a938ea022a689f7b6f2d79cbb22ea62f55d1b2656bb3da0454aadf70
BLAKE2b-256 checksum
How to use checksums
d64c5cc65a4a9e42d098a007668e67f7f948d1c5353c45966d3e695ade745593
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

Security for zemfrog 5.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page