# django-handy-helpers
| | | |
|--------------|------|---|
| Author | David Slusser | |
| Description | A collection of handy utilities to support django projects | |
| Requirements | `Python 3.x`<br>`Django 2.2.x` | |
# Documentation
Full documentation can be found on http://django-handyhelpers.readthedocs.org.
Documentation source files are available in the docs folder.
# How to Install
The django-userextensions package is available on Python Package Index (PyPI) and can be installed via pip:
pip install django-handyhelpers
add 'handyhelpers' to your INSTALLED_APPS (for management commands and templates)
INSTALLED_APPS = [
...
'handyhelpers',
]
# Management Commands
### DRF Generator
Django-handyhelpers includes manage.py commands to generate DRF files (api views, serializers, urls) for a given app in your project.
This is done using jinja templates that define the structure of each file. Default templates are provided, and custom templates
can be provided in the command. By default, all models and models fields are included.
Example command:
manage.py generate_drf <my_app> --serializer
manage.py generate_drf <my_app> --serializer --serializer_template <my_custom_template>
** use the --help parameter for a full list of options
manage.py generate_drf --help
### Admin Generator
Included with django-handyhelpers are manage.py commands to auto-generate an admin.py file for a given application in
your project. This is done using a jinja template that defines the structure of the admin.py file. A default template is
provided.
Example command:
manage.py generate_admin <my_app>
manage.py generate_admin <my_app> --template <my_custom_template>
** use the --help parameter for a full list of options
manage.py generate-admin --help
# Mixins
### FilterByQueryParamsMixin
Allows your list views to be filtered by query parameters.
### InvalidLookupMixin
Returns an applicable error, instead of results based on an unfiltered queryset, if a provided lookup expression,
filter, or model field is invalid.
Raw data
{
"_id": null,
"home_page": "https://github.com/davidslusser/django-handyhelpers",
"name": "django-handyhelpers",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django, helpers, handyhelpers",
"author": "David Slusser",
"author_email": "dbslusser@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b3/94/b2b24d2184d9203f492d391cf6e1b98d279413d5e079b4d46e2e96f58fc8/django_handyhelpers-0.3.24.tar.gz",
"platform": null,
"description": "# django-handy-helpers\n\n\n| | | |\n|--------------|------|---|\n| Author | David Slusser | |\n| Description | A collection of handy utilities to support django projects | |\n| Requirements | `Python 3.x`<br>`Django 2.2.x` | |\n\n\n# Documentation\nFull documentation can be found on http://django-handyhelpers.readthedocs.org. \nDocumentation source files are available in the docs folder.\n\n\n# How to Install\nThe django-userextensions package is available on Python Package Index (PyPI) and can be installed via pip:\n\n pip install django-handyhelpers\n \n\nadd 'handyhelpers' to your INSTALLED_APPS (for management commands and templates)\n\n INSTALLED_APPS = [\n ...\n 'handyhelpers',\n ]\n\n\n# Management Commands \n\n### DRF Generator\nDjango-handyhelpers includes manage.py commands to generate DRF files (api views, serializers, urls) for a given app in your project.\nThis is done using jinja templates that define the structure of each file. Default templates are provided, and custom templates \ncan be provided in the command. By default, all models and models fields are included. \n\nExample command:\n\n manage.py generate_drf <my_app> --serializer\n manage.py generate_drf <my_app> --serializer --serializer_template <my_custom_template>\n\n** use the --help parameter for a full list of options\n\n manage.py generate_drf --help\n\n\n\n### Admin Generator\nIncluded with django-handyhelpers are manage.py commands to auto-generate an admin.py file for a given application in \nyour project. This is done using a jinja template that defines the structure of the admin.py file. A default template is \nprovided. \n\nExample command:\n\n manage.py generate_admin <my_app>\n manage.py generate_admin <my_app> --template <my_custom_template>\n \n** use the --help parameter for a full list of options\n \n manage.py generate-admin --help \n\n\n# Mixins\n\n### FilterByQueryParamsMixin\nAllows your list views to be filtered by query parameters.\n\n\n### InvalidLookupMixin\nReturns an applicable error, instead of results based on an unfiltered queryset, if a provided lookup expression, \nfilter, or model field is invalid. \n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A collection of handy utilities to support django operations",
"version": "0.3.24",
"project_urls": {
"Download": "https://github.com/davidslusser/django-handyhelpers/archive/0.3.24.tar.gz",
"Homepage": "https://github.com/davidslusser/django-handyhelpers"
},
"split_keywords": [
"django",
" helpers",
" handyhelpers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1c5053924b46613b6e92083e32046dafe299b8536142ad99d2715916332b401",
"md5": "24244e67371f5e2150955ff0840468b4",
"sha256": "8325afa83f122f3a2fa9dfb3e04c71bd1767942a34cc13ab4a0fa003d1d48d86"
},
"downloads": -1,
"filename": "django_handyhelpers-0.3.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24244e67371f5e2150955ff0840468b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18817658,
"upload_time": "2024-04-18T23:14:16",
"upload_time_iso_8601": "2024-04-18T23:14:16.429861Z",
"url": "https://files.pythonhosted.org/packages/f1/c5/053924b46613b6e92083e32046dafe299b8536142ad99d2715916332b401/django_handyhelpers-0.3.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b394b2b24d2184d9203f492d391cf6e1b98d279413d5e079b4d46e2e96f58fc8",
"md5": "65e98ca6d0a2cd076a8dad81cd3b4be3",
"sha256": "8073614d6e4f1067363cef3b3b23c4fef61f2cfd75cbcdb52b7796402af59eb9"
},
"downloads": -1,
"filename": "django_handyhelpers-0.3.24.tar.gz",
"has_sig": false,
"md5_digest": "65e98ca6d0a2cd076a8dad81cd3b4be3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15639758,
"upload_time": "2024-04-18T23:14:21",
"upload_time_iso_8601": "2024-04-18T23:14:21.340812Z",
"url": "https://files.pythonhosted.org/packages/b3/94/b2b24d2184d9203f492d391cf6e1b98d279413d5e079b4d46e2e96f58fc8/django_handyhelpers-0.3.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 23:14:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "davidslusser",
"github_project": "django-handyhelpers",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "django-handyhelpers"
}
JSON
