Skip to main content

No project description provided

Project description

A small framework helping to write reusable Django applications using generic relations
Author: Mikhail Porokhovnichenko
License: MIT license
Description: ======================

.. image::

.. image::

.. image::

.. image::

.. image::
:alt: Wheel Status

.. image::
:alt: Supported Python versions

This app provides some snippets (such as abstract models and managers
with some useful methods) to simplyfy creation of another pluggable apps.

The license is MIT.


.. code:: bash

pip install django-generic-helpers

After you can add the `generic_helpers` app into your `INSTALLED_APPS`. If you aren't
want to run test, you can skip this step.


To use this app, just import GenericRelationModel class from
generic_helpers.models package and inherit your model from it:

.. code:: python

from django.db import models
from generic_helpers.models import GenericRelationModel

class MyModel(GenericRelationModel):
title = models.CharField(max_length=255)

Now MyModel class has content_object attribute and you can create MyModel
instances using generic relation:

.. code:: python

>>> from django.contrib.auth.models import User
>>> user = User.objects.get(pk=1)
>>> my_model = MyModel.objects.create(title='title',
... content_object=user)

In this example how you can see we have used User.

Also your model manager has a get_for_object method for quick filtering by
content_object complex field:

.. code:: python

>>> from django.contrib.auth.models import User
>>> user = User.objects.get(pk=1)
>>> models_for_user = MyModel.objects.get_for_object(user)


If you've found a bug, implemented a feature and think it is useful, or you've
own pluggable app and want to use django-generic-helpers in it, then please
consider contributing. Patches, pull requests or just suggestions are welcome!

Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-generic-helpers-1.0.0.tar.bz2 (7.6 kB view hashes)

Uploaded Source

Built Distribution

django_generic_helpers-1.0.0-py2.py3-none-any.whl (9.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page