Meringue

A package providing various utilities for Django, such as mixins, form tools, upload handlers, and more.

This library is a collection of reusable components that I frequently use across different projects. Its primary purpose is to clean up and standardize these tools, ensure they are well-tested, and provide clear documentation to make it easy for colleagues to understand and use.

If you decide to use this in your project, or want to improve the implementation, feel free to reach out by mail, create an issue or pull request on GitHub. Contributions are always welcome!

Read more in the documentation.

Roadmap

Adding new functionality. Can change.

• DRF serializer for automatic form generation on the frontend via REST API. (An npm package for Vue.js will also be developed to generate forms based on API responses).
• Authentication backend for email and password login.
• Functionality for working with images.
  • Image editor like easy_thumbnails.
  • A DRF serializer field that returns a set of images in multiple sizes (e.g., standard and 2x for retina) and formats (e.g., original and WebP).
  • Job chain presets
  • Tests
  • Docs
• Similar image-processing functionality but for video.
• Functionality for loading private files available through nginx internal.

Contributing

• Use Git Flow (read here and here) to resolve the versioning
• Linting with Ruff
• Formatting with 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 ???

---