meringue 1.1.0.dev2

A set of various functionality for a Django based web application.

Meringue

Full documentation for the project is available at dd.github.io/Meringue.

Package with various functional (such as mixins, form utils, upload handlers and other) for Django Framework.

This library is a set of various functionality that I use from project to project.

The main task of this package is to clean up this functionality, test it, and also organize the documentation so that colleagues can understand how and what works.

However, if someone decides to use this functionality in their project, and even more so to add functionality or change the implementation to a more correct, beautiful or understandable one, I will only be happy, do not worry and feel free to write to me by mail, create an issue or pull request on github.

Roadmap

Adding new functionality. Can change.

• Universal manager worked with all abstract models
• Tests of all functionality
• Methods for encrypting and decrypting text content (To create various secrets, such as a link to change your password or activate your profile).
• Functionality for obtaining absolute links to resources presented on the front, located on another domain (When working through api) (utils methods, template tags and filters).
• drf serializer serializer for automatic form generation on the front when working through rest api. (An npm package on vuejs will also be developed generating form based on response from api).
• Extended drf router that allows you to add resources like /profile returning the profile data of an authorized user without his id.
• Authorization backend for authorization by a pair of email and password.
• Helpers to extend documentation generated by drf-spectacular - just a small helper to easily add links to different deployed environments (production, test, local, etc.) or let's say for more digestible tags instead of initially generated ones
• Functionality for working with images.
  • Image editor like easy_thumbnails.
  • A field for the drf serializer that returns a set of images (for example, a standard image and a double-sized image for a retina screen), as well as in different formats (for example, in the original format and in webp).
• Functionality similar to that described in the previous paragraph only for video.
• Functionality for loading private files available through nginx internal.
• Exception handler for drf that returns an error code in addition to the error text

Contributing

• Use Git Flow (read here and here) to resolve the versioning
• Linter with a Ruff
• Formatter with a Black
• Lint commit with Gitlint and Conventional Commits
• Documentation with mkdocs and mkdocs-material
• Testing local with hatch
• Testing in CI/CD on push
• Add mypy ???