https://github.com/dd/meringue

A set of various functionality for a Django based web application.
https://github.com/dd/meringue

django python python3

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dd/meringue
• Owner: dd
• License: mpl-2.0
• Created: 2014-06-10T16:15:04.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2025-04-07T01:11:26.000Z (about 1 year ago)
• Last Synced: 2025-07-23T14:11:57.908Z (11 months ago)
• Topics: django, python, python3
• Language: Python
• Homepage: http://dd.github.io/Meringue/
• Size: 4.44 MB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
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](mailto:dd@tovarisch.engineer), create an [issue](https://github.com/dd/Meringue/issues) or [pull request](https://github.com/dd/Meringue/pulls) on [GitHub](https://github.com/dd/Meringue). Contributions are always welcome!

Read more in the [documentation](https://dd.github.io/Meringue/).

## Roadmap

Adding new functionality. Can change.

* [ ] [DRF](https://www.django-rest-framework.org/) serializer for automatic form generation on the frontend via REST API. (An npm package for [Vue.js](https://vuejs.org/) will also be developed to generate forms based on API responses).

* [ ] Authentication backend for email and password login.

* [ ] Functionality for working with images.

	* [x] Image editor like easy_thumbnails.

	* [x] 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.

* [x] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).

## Contributing

- [x] Use Git Flow (read [here](https://jeffkreeftmeijer.com/git-flow/) and [here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)) to resolve the versioning

- [x] Linting with [Ruff](https://github.com/charliermarsh/ruff)

- [x] Formatting with [Black](https://github.com/psf/black)

- [x] Lint commit with [Gitlint](https://jorisroovers.com/gitlint/) and [Conventional Commits](https://www.conventionalcommits.org/)

- [x] Documentation with [mkdocs](https://www.mkdocs.org/) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)

- [x] Testing local with [hatch](https://hatch.pypa.io/1.7/meta/faq/#environments)

- [x] Testing in CI/CD on push

- [ ] Add [mypy](https://mypy-lang.org/) ???