django-utils-kit


Namedjango-utils-kit JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryBundle of useful classes and functions for Django
upload_time2024-11-15 15:41:43
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2024 Jordan Kowal Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords django utils utilities kit djangorestframework drf
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ✨ Django Utils Kit ✨

![Code quality](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/code_quality.yml/badge.svg?branch=main)
![Tests](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/tests.yml/badge.svg?branch=main)
![Build](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/publish_package.yml/badge.svg?event=release)
![Coverage](https://badgen.net/badge/coverage/%3E90%25/pink)
![Tag](https://badgen.net/badge/tag/1.0.0/orange)
![Python](https://badgen.net/badge/python/3.9%20|%203.10%20|%203.11%20|%203.12|%203.13)
![Licence](https://badgen.net/badge/licence/MIT)

- [✨ Django Utils Kit ✨](#-django-utils-kit-)
  - [💻 How to install](#-how-to-install)
  - [📕 Available imports](#-available-imports)
  - [🔗 Useful links](#-useful-links)

Provides various utilities for working with Django and DRF:

- [admin.py](./django_utils_kit/admin.py): Additional classes and mixins for Django admin.
- [emails.py](./django_utils_kit/emails.py): Classes to easily send sync and async emails through Django.
- [exceptions.py](./django_utils_kit/exceptions.py): Additional exceptions for DRF.
- [files.py](./django_utils_kit/files.py): Utilities for handling files with DRF.
- [images.py](./django_utils_kit/images.py): Utilities for handling images within Django.
- [models.py](./django_utils_kit/models.py): Additional classes and utilities for Django models.
- [network.py](./django_utils_kit/network.py): Network related utilities to handle requests.
- [permissions.py](./django_utils_kit/permissions.py): Additional permissions for DRF.
- [serializers.py](./django_utils_kit/serializers.py): Additional serializers and fields for DRF.
- [test_runner.py](./django_utils_kit/test_runner.py): Custom test runners for Django.
- [test_utils.py](./django_utils_kit/test_utils.py): Additional TestCase classes with new assertions and utilities.
- [viewsets.py](./django_utils_kit/viewsets.py): Custom ViewSets for DRF.

## 💻 How to install

The package is available on PyPi with the name `django_utils_kit`.
Simply run:

```shell
pip install django_utils_kit
```

## 📕 Available imports

Here's a list of all available imports for this package:

```python
from django_utils_kit.admin import ReadOnlyAdminMixin
from django_utils_kit.emails import Email
from django_utils_kit.exceptions import Conflict, FailedPrecondition
from django_utils_kit.files import download_file, download_files_as_zip
from django_utils_kit.images import (
    downsize_and_save_image_from_path,
    downsize_image,
    image_to_base64,
)
from django_utils_kit.models import (
    FileNameWithUUID,
    ImprovedModel,
    PreCleanedAbstractModel,
    update_m2m,
    update_model_instance,
)
from django_utils_kit.network import get_client_ip, get_server_domain
from django_utils_kit.permissions import BlockAll, IsNotAuthenticated
from django_utils_kit.serializers import ReadOnlyModelSerializer, ThumbnailField
from django_utils_kit.test_runners import TimedTestRunner
from django_utils_kit.test_utils import APITestCase, AssertionTestCase, ImprovedTestCase
from django_utils_kit.viewsets import ImprovedViewSet

```

## 🔗 Useful links

- [Want to contribute?](CONTRIBUTING.md)
- [See what's new!](CHANGELOG.md)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "django-utils-kit",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Jordan Kowal <kowaljordan@gmail.com>",
    "keywords": "django, utils, utilities, kit, djangorestframework, drf",
    "author": null,
    "author_email": "Jordan Kowal <kowaljordan@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/6c/2a/4596ec21de4641e2b2f4ebf53b5d4859582aec3477bf62ff7f1529aeca43/django_utils_kit-1.0.0.tar.gz",
    "platform": null,
    "description": "# \u2728 Django Utils Kit \u2728\n\n![Code quality](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/code_quality.yml/badge.svg?branch=main)\n![Tests](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/tests.yml/badge.svg?branch=main)\n![Build](https://github.com/Jordan-Kowal/django-utils-kit/actions/workflows/publish_package.yml/badge.svg?event=release)\n![Coverage](https://badgen.net/badge/coverage/%3E90%25/pink)\n![Tag](https://badgen.net/badge/tag/1.0.0/orange)\n![Python](https://badgen.net/badge/python/3.9%20|%203.10%20|%203.11%20|%203.12|%203.13)\n![Licence](https://badgen.net/badge/licence/MIT)\n\n- [\u2728 Django Utils Kit \u2728](#-django-utils-kit-)\n  - [\ud83d\udcbb How to install](#-how-to-install)\n  - [\ud83d\udcd5 Available imports](#-available-imports)\n  - [\ud83d\udd17 Useful links](#-useful-links)\n\nProvides various utilities for working with Django and DRF:\n\n- [admin.py](./django_utils_kit/admin.py): Additional classes and mixins for Django admin.\n- [emails.py](./django_utils_kit/emails.py): Classes to easily send sync and async emails through Django.\n- [exceptions.py](./django_utils_kit/exceptions.py): Additional exceptions for DRF.\n- [files.py](./django_utils_kit/files.py): Utilities for handling files with DRF.\n- [images.py](./django_utils_kit/images.py): Utilities for handling images within Django.\n- [models.py](./django_utils_kit/models.py): Additional classes and utilities for Django models.\n- [network.py](./django_utils_kit/network.py): Network related utilities to handle requests.\n- [permissions.py](./django_utils_kit/permissions.py): Additional permissions for DRF.\n- [serializers.py](./django_utils_kit/serializers.py): Additional serializers and fields for DRF.\n- [test_runner.py](./django_utils_kit/test_runner.py): Custom test runners for Django.\n- [test_utils.py](./django_utils_kit/test_utils.py): Additional TestCase classes with new assertions and utilities.\n- [viewsets.py](./django_utils_kit/viewsets.py): Custom ViewSets for DRF.\n\n## \ud83d\udcbb How to install\n\nThe package is available on PyPi with the name `django_utils_kit`.\nSimply run:\n\n```shell\npip install django_utils_kit\n```\n\n## \ud83d\udcd5 Available imports\n\nHere's a list of all available imports for this package:\n\n```python\nfrom django_utils_kit.admin import ReadOnlyAdminMixin\nfrom django_utils_kit.emails import Email\nfrom django_utils_kit.exceptions import Conflict, FailedPrecondition\nfrom django_utils_kit.files import download_file, download_files_as_zip\nfrom django_utils_kit.images import (\n    downsize_and_save_image_from_path,\n    downsize_image,\n    image_to_base64,\n)\nfrom django_utils_kit.models import (\n    FileNameWithUUID,\n    ImprovedModel,\n    PreCleanedAbstractModel,\n    update_m2m,\n    update_model_instance,\n)\nfrom django_utils_kit.network import get_client_ip, get_server_domain\nfrom django_utils_kit.permissions import BlockAll, IsNotAuthenticated\nfrom django_utils_kit.serializers import ReadOnlyModelSerializer, ThumbnailField\nfrom django_utils_kit.test_runners import TimedTestRunner\nfrom django_utils_kit.test_utils import APITestCase, AssertionTestCase, ImprovedTestCase\nfrom django_utils_kit.viewsets import ImprovedViewSet\n\n```\n\n## \ud83d\udd17 Useful links\n\n- [Want to contribute?](CONTRIBUTING.md)\n- [See what's new!](CHANGELOG.md)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Jordan Kowal  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Bundle of useful classes and functions for Django",
    "version": "1.0.0",
    "project_urls": {
        "Changelog": "https://github.com/Jordan-Kowal/django-utils-kit/blob/main/CHANGELOG.md",
        "Issues": "https://github.com/Jordan-Kowal/django-utils-kit/issues",
        "Release notes": "https://github.com/Jordan-Kowal/django-utils-kit/releases",
        "Source": "https://github.com/Jordan-Kowal/django-utils-kit"
    },
    "split_keywords": [
        "django",
        " utils",
        " utilities",
        " kit",
        " djangorestframework",
        " drf"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0cdcfc3574c5e02c29b898ed50d803824aff1f65166b811e25b850080e0c1216",
                "md5": "7cd8294bfa896b9bc02a571f15c9236d",
                "sha256": "e5903bf868b1c5d0c3dffd20889c5e867a17dd4161f22d60b1fb6cf265e11069"
            },
            "downloads": -1,
            "filename": "django_utils_kit-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7cd8294bfa896b9bc02a571f15c9236d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 17799,
            "upload_time": "2024-11-15T15:41:42",
            "upload_time_iso_8601": "2024-11-15T15:41:42.647193Z",
            "url": "https://files.pythonhosted.org/packages/0c/dc/fc3574c5e02c29b898ed50d803824aff1f65166b811e25b850080e0c1216/django_utils_kit-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c2a4596ec21de4641e2b2f4ebf53b5d4859582aec3477bf62ff7f1529aeca43",
                "md5": "193d014627f74b5446514f996b86476f",
                "sha256": "b13c5a09ad7488af8a8d906615cec3f1f494e5eaa1bfc4ca6a51700630711b8c"
            },
            "downloads": -1,
            "filename": "django_utils_kit-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "193d014627f74b5446514f996b86476f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 16059,
            "upload_time": "2024-11-15T15:41:43",
            "upload_time_iso_8601": "2024-11-15T15:41:43.798107Z",
            "url": "https://files.pythonhosted.org/packages/6c/2a/4596ec21de4641e2b2f4ebf53b5d4859582aec3477bf62ff7f1529aeca43/django_utils_kit-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-15 15:41:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Jordan-Kowal",
    "github_project": "django-utils-kit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "django-utils-kit"
}
        
Elapsed time: 9.70606s