| Name | meringue JSON |
| Version |
1.2.0
JSON |
| download |
| home_page | None |
| Summary | A set of various functionality for a Django based web application. |
| upload_time | 2024-04-07 22:15:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
django
utils
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center" >Meringue</h1>
<p align="center">
<a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/status/meringue.svg" alt="PyPI - Status" />
</a>
<a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/v/meringue.svg" alt="PyPI - Version" />
</a>
<a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/dm/meringue.svg" alt="PyPI - Downloads" />
</a>
<!-- <a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/frameworkversions/django/meringue.svg" alt="PyPI - Django Framework Version" />
</a> -->
<a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/pyversions/meringue.svg" alt="PyPI - Python Version" />
</a>
<a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/frameworkversions/django/meringue" alt="PyPI - Versions from Framework Classifiers" />
</a>
<!-- <a href="https://pypi.org/project/meringue">
<img src="https://img.shields.io/pypi/format/meringue.svg" alt="PyPI - Format" />
</a> -->
</p>
<p align="center">
<a href="https://github.com/dd/Meringue/actions/workflows/mkdocs-release.yml" >
<img src="https://img.shields.io/github/actions/workflow/status/dd/Meringue/mkdocs-release.yml?logo=github&label=docs" alt="Documentation - Release" />
</a>
<a href="https://github.com/dd/Meringue/actions/workflows/test.yml" >
<img src="https://img.shields.io/github/actions/workflow/status/dd/Meringue/test.yml?logo=github&label=tests" alt="Tests - Running" />
</a>
<a href="https://codecov.io/gh/dd/Meringue" >
<img src="https://codecov.io/gh/dd/Meringue/branch/master/graph/badge.svg?token=HV1QGD74EK" alt="Tests - Coverage" />
</a>
</p>
<p align="center">
<a href="https://github.com/pypa/hatch" target="_blank">
<img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch project" />
</a>
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank">
<img src="https://img.shields.io/badge/-Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white&labelColor=gray" alt="Built with Material for MkDocs" />
</a>
<a href="https://github.com/charliermarsh/ruff" target="_blank">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="linting - Ruff" />
</a>
<a href="https://github.com/psf/black" target="_blank">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="code style - black" />
</a>
<!-- <a href="https://github.com/python/mypy" target="_blank">
<img src="https://img.shields.io/badge/types-Mypy-blue.svg" alt="types - Mypy" />
</a> -->
<a href="https://raw.githubusercontent.com/dd/Meringue/master/LICENSE" target="_blank">
<img src="https://img.shields.io/pypi/l/meringue?color=008033" alt="License - GNU Lesser General Public License v3.0" />
</a>
</p>
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](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).
Read more in the [documentation](https://dd.github.io/Meringue/).
## Roadmap
Adding new functionality. Can change.
* [ ] [drf](https://www.django-rest-framework.org/) serializer serializer for automatic form generation on the front when working through rest api. (An npm package on [vuejs](https://vuejs.org/) will also be developed generating form based on response from api).
* [ ] Authorization backend for authorization by a pair of email and password.
* [ ] Functionality for working with images.
* [x] Image editor like easy_thumbnails.
* [x] 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).
* [ ] Job chain presets
* [ ] Tests
* [ ] Docs
* [ ] Functionality similar to that described in the previous paragraph only 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] Linter with a [Ruff](https://github.com/charliermarsh/ruff)
- [x] Formatter with a [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/) ???
Raw data
{
"_id": null,
"home_page": null,
"name": "meringue",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "django, utils",
"author": null,
"author_email": "Dmitry Dobrynin <dd@tovarisch.engineer>",
"download_url": "https://files.pythonhosted.org/packages/3f/76/b92bf0ab9f36bfb1d2b0c32de416fc5cac101789588d36038a290bed279b/meringue-1.2.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\" >Meringue</h1>\n\n<p align=\"center\">\n\t<a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/status/meringue.svg\" alt=\"PyPI - Status\" />\n\t</a>\n\t<a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/v/meringue.svg\" alt=\"PyPI - Version\" />\n\t</a>\n\t<a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/dm/meringue.svg\" alt=\"PyPI - Downloads\" />\n\t</a>\n\t<!-- <a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/frameworkversions/django/meringue.svg\" alt=\"PyPI - Django Framework Version\" />\n\t</a> -->\n\t<a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/pyversions/meringue.svg\" alt=\"PyPI - Python Version\" />\n\t</a>\n\t<a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/frameworkversions/django/meringue\" alt=\"PyPI - Versions from Framework Classifiers\" />\n\t</a>\n\t<!-- <a href=\"https://pypi.org/project/meringue\">\n\t\t<img src=\"https://img.shields.io/pypi/format/meringue.svg\" alt=\"PyPI - Format\" />\n\t</a> -->\n</p>\n<p align=\"center\">\n\t<a href=\"https://github.com/dd/Meringue/actions/workflows/mkdocs-release.yml\" >\n\t\t<img src=\"https://img.shields.io/github/actions/workflow/status/dd/Meringue/mkdocs-release.yml?logo=github&label=docs\" alt=\"Documentation - Release\" />\n\t</a>\n\t<a href=\"https://github.com/dd/Meringue/actions/workflows/test.yml\" >\n\t\t<img src=\"https://img.shields.io/github/actions/workflow/status/dd/Meringue/test.yml?logo=github&label=tests\" alt=\"Tests - Running\" />\n\t</a>\n\t<a href=\"https://codecov.io/gh/dd/Meringue\" >\n\t\t<img src=\"https://codecov.io/gh/dd/Meringue/branch/master/graph/badge.svg?token=HV1QGD74EK\" alt=\"Tests - Coverage\" />\n\t</a>\n</p>\n<p align=\"center\">\n\t<a href=\"https://github.com/pypa/hatch\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\" alt=\"Hatch project\" />\n\t</a>\n\t<a href=\"https://squidfunk.github.io/mkdocs-material/\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/badge/-Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white&labelColor=gray\" alt=\"Built with Material for MkDocs\" />\n\t</a>\n\t<a href=\"https://github.com/charliermarsh/ruff\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json\" alt=\"linting - Ruff\" />\n\t</a>\n\t<a href=\"https://github.com/psf/black\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"code style - black\" />\n\t</a>\n\t<!-- <a href=\"https://github.com/python/mypy\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/badge/types-Mypy-blue.svg\" alt=\"types - Mypy\" />\n\t</a> -->\n\t<a href=\"https://raw.githubusercontent.com/dd/Meringue/master/LICENSE\" target=\"_blank\">\n\t\t<img src=\"https://img.shields.io/pypi/l/meringue?color=008033\" alt=\"License - GNU Lesser General Public License v3.0\" />\n\t</a>\n</p>\n\nPackage with various functional (such as mixins, form utils, upload handlers and other) for Django Framework.\n\nThis library is a set of various functionality that I use from project to project.\n\nThe 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.\n\nHowever, 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](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).\n\nRead more in the [documentation](https://dd.github.io/Meringue/).\n\n\n## Roadmap\n\nAdding new functionality. Can change.\n\n* [ ] [drf](https://www.django-rest-framework.org/) serializer serializer for automatic form generation on the front when working through rest api. (An npm package on [vuejs](https://vuejs.org/) will also be developed generating form based on response from api).\n* [ ] Authorization backend for authorization by a pair of email and password.\n* [ ] Functionality for working with images.\n\t* [x] Image editor like easy_thumbnails.\n\t* [x] 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).\n\t* [ ] Job chain presets\n\t* [ ] Tests\n\t* [ ] Docs\n* [ ] Functionality similar to that described in the previous paragraph only for video.\n* [x] Functionality for loading private files available through [nginx internal](http://nginx.org/en/docs/http/ngx_http_core_module.html#internal).\n\n\n## Contributing\n\n- [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\n- [x] Linter with a [Ruff](https://github.com/charliermarsh/ruff)\n- [x] Formatter with a [Black](https://github.com/psf/black)\n- [x] Lint commit with [Gitlint](https://jorisroovers.com/gitlint/) and [Conventional Commits](https://www.conventionalcommits.org/)\n- [x] Documentation with [mkdocs](https://www.mkdocs.org/) and [mkdocs-material](https://squidfunk.github.io/mkdocs-material/)\n- [x] Testing local with [hatch](https://hatch.pypa.io/1.7/meta/faq/#environments)\n- [x] Testing in CI/CD on push\n- [ ] Add [mypy](https://mypy-lang.org/) ???\n",
"bugtrack_url": null,
"license": null,
"summary": "A set of various functionality for a Django based web application.",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://github.com/dd/Meringue/issues",
"Changelog": "https://github.com/dd/Meringue/blob/master/CHANGELOG.md",
"Documentation": "https://dd.github.io/Meringue",
"Repository": "https://github.com/dd/Meringue"
},
"split_keywords": [
"django",
" utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "69b45c2211b7a7e32ff9829ae5b5ea413e3a614670957cd83316ca0b6913b794",
"md5": "5c8ca213b813173c22a0c35379bc2825",
"sha256": "ee97f64fe98100eef07762b59fce1bdfcf444960a9b4929af2e84bdf02fe97c0"
},
"downloads": -1,
"filename": "meringue-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c8ca213b813173c22a0c35379bc2825",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 40770,
"upload_time": "2024-04-07T22:15:52",
"upload_time_iso_8601": "2024-04-07T22:15:52.819486Z",
"url": "https://files.pythonhosted.org/packages/69/b4/5c2211b7a7e32ff9829ae5b5ea413e3a614670957cd83316ca0b6913b794/meringue-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3f76b92bf0ab9f36bfb1d2b0c32de416fc5cac101789588d36038a290bed279b",
"md5": "5a4ed28019c43a1276edba2c146412cc",
"sha256": "57cd63d5c76fa4cdfb0074a415a97d60746f38a22add32eeab5aea51706fdb38"
},
"downloads": -1,
"filename": "meringue-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "5a4ed28019c43a1276edba2c146412cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 29007,
"upload_time": "2024-04-07T22:15:54",
"upload_time_iso_8601": "2024-04-07T22:15:54.302599Z",
"url": "https://files.pythonhosted.org/packages/3f/76/b92bf0ab9f36bfb1d2b0c32de416fc5cac101789588d36038a290bed279b/meringue-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-07 22:15:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dd",
"github_project": "Meringue",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "meringue"
}
