https://github.com/orsinium-archive/djburger

Framework for safe and maintainable web-projects.
https://github.com/orsinium-archive/djburger

api cbv clean-code contracts-programming decorators design-by-contract django django-rest-framework marshmallow mvc mvc-framework parse python rest rest-api restful-api scheme solid validation validator

Last synced: 3 months ago
JSON representation

Framework for safe and maintainable web-projects.

• Host: GitHub
• URL: https://github.com/orsinium-archive/djburger
• Owner: orsinium-archive
• License: lgpl-3.0
• Archived: true
• Created: 2017-12-02T13:32:59.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-02-12T00:15:20.000Z (almost 5 years ago)
• Last Synced: 2024-05-19T07:27:10.670Z (8 months ago)
• Topics: api, cbv, clean-code, contracts-programming, decorators, design-by-contract, django, django-rest-framework, marshmallow, mvc, mvc-framework, parse, python, rest, rest-api, restful-api, scheme, solid, validation, validator
• Language: Python
• Homepage: https://djburger.readthedocs.io
• Size: 233 KB
• Stars: 75
• Watchers: 6
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - djburger - Framework for safe and maintainable web-projects. (Python)

README

        
# DjBurger

![DjBurger logo](wiki/source/imgs/logo.png)

[![Build Status](https://travis-ci.org/orsinium/djburger.svg?branch=master)](https://travis-ci.org/orsinium/djburger) [![Documentation](https://readthedocs.org/projects/djburger/badge/)](https://djburger.readthedocs.io/en/latest/) [![PyPI version](https://img.shields.io/pypi/v/djburger.svg)](https://pypi.python.org/pypi/djburger) [![Status](https://img.shields.io/pypi/status/djburger.svg)](https://pypi.python.org/pypi/djburger) [![Code size](https://img.shields.io/github/languages/code-size/orsinium/djburger.svg)](https://github.com/orsinium/djburger) [![License](https://img.shields.io/pypi/l/djburger.svg)](LICENSE)

**DjBurger** -- framework for safe and maintainable web-projects.

What DjBurger do?

* Split Django views into [steps](https://djburger.readthedocs.io/en/latest/philosophy.html#dataflow) for secure and clean code.

* Provide built-in objects for all steps.

* Integrates this [many side libraries](https://djburger.readthedocs.io/en/latest/external.html) like Django REST Framework and Marshmallow.

DjBurger doesn't depend on Django. You can use it in any projects if you want.

Read more into [documentation](https://djburger.readthedocs.io/en/latest/).

## Key principles

1. Validation logic is separate from the main logic.

2. Reusable logic for many views.

3. Reusable input and output data formats.

4. More clean views.

## Dataflow

1. **Decorators**. Feel free to use any side Django decorators like `csrf_exempt`.

2. **Parser**. Parse request body.

3. **PreValidator**. Validate and clear request.

4. **PreRenderer**. Render and return PreValidation errors response.

5. **Controller**. Main logic: do some things.

6. **PostValidator**. Validate and clear response.

7. **PostRenderer**. Render and return PostValidation errors response.

8. **Renderer**. Render successful response.

![Scheme](wiki/source/imgs/scheme.png)

Required only Controller and Renderer.

## Explore

1. Read [documentation](https://djburger.readthedocs.io/en/latest/).

1. See [example](example/) project.

1. For quick help just inspect djburger from python console (for example, `help('djburger.views')`).

1. If you have some questions then [view issues](https://github.com/orsinium/djburger/issues) or [create new](https://github.com/orsinium/djburger/issues/new).

1. If you found some mistakes then fix it and [create Pull Request](https://github.com/orsinium/djburger/compare). Contributors are welcome.

1. [Star this project on github](https://github.com/orsinium/djburger) :)