{"id":22196675,"url":"https://github.com/druids/django-generic-m2m-field","last_synced_at":"2025-07-05T01:03:58.120Z","repository":{"id":43185517,"uuid":"237997075","full_name":"druids/django-generic-m2m-field","owner":"druids","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-03T12:49:15.000Z","size":28,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-03T16:07:53.687Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/druids.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-03T15:26:49.000Z","updated_at":"2022-07-25T11:00:29.000Z","dependencies_parsed_at":"2023-02-01T06:16:03.648Z","dependency_job_id":null,"html_url":"https://github.com/druids/django-generic-m2m-field","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/druids/django-generic-m2m-field","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druids%2Fdjango-generic-m2m-field","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druids%2Fdjango-generic-m2m-field/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druids%2Fdjango-generic-m2m-field/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druids%2Fdjango-generic-m2m-field/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/druids","download_url":"https://codeload.github.com/druids/django-generic-m2m-field/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/druids%2Fdjango-generic-m2m-field/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262123033,"owners_count":23262516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T14:16:02.465Z","updated_at":"2025-06-26T18:32:59.995Z","avatar_url":"https://github.com/druids.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Prolog\n======\n\n`Django-generic-m2m-field` extends the Django framework with a `GenericManyToManyField`. The field is similar to the standard `ManyToManyField` but uses Django's `GenericForeignKey` to relate to many different models.\n\nInstallation\n------------\n\n- Install `django-generic-m2m-field` with the `pip` command:\n\n```bash\npip install django-generic-m2m-field\n```\n\n- Add `'generic_m2m_field'` to your `INSTALLED_APPS`:\n\n```python\nINSTALLED_APPS = [\n    # Django apps...\n    'generic_m2m_field',\n]\n```\n\nUsage\n-----\nImagine having an e-mail message log model where you need to relate more of different kinds of objects to the message:\n\n```python\nfrom django.db import models\nfrom generic_m2m_field.models import GenericManyToManyField\n\n\nclass EmailMessage(models.Model):\n\n    recipient = models.EmailField(verbose_name=_('recipient'), blank=False, null=False)\n    sender = models.EmailField(verbose_name=_('sender'), blank=False, null=False)\n    subject = models.TextField(verbose_name=_('subject'), blank=False, null=False)\n    related_objects = GenericManyToManyField()\n\n```\n\nNow you can join your `EmailMessage` instance with any instance of any other model (User in this example):\n\n\n```python\nfrom django.contrib.auth.models import User\n\nuser1, user2 = User.objects.all()\n\nemail_message = EmailMessage.objects.first()\n\n# Add user1 and user2\nemail_message.related_objects.add(user1)\nemail_message.related_objects.add(user1, user2)\n\n# Remove user2\nemail_message.related_objects.remove(user2)\n\n# Clear all relations\nemail_message.related_objects.clear()\n\n# Set relations\nemail_message.related_objects.set(user2)\n\n# Get all related object pks of User model (casted to right type)\nemail_message.related_objects.get_object_pks(User)\n\n# Get all related object pks of User model\nemail_message.related_objects.get_objects(User)\n\n```\n\nMultiple DB\n-----------\n\nDjango doesn't support foreign key for multiple databases. If you want to use generic m2m relation for models stored in different databases you can use ``MultipleDBGenericManyToManyField`` with the same way as GenericManyToManyField\n\n\n```python\nfrom django.db import models\nfrom generic_m2m_field.models import MultipleDBGenericManyToManyField\n\n\nclass EmailMessage(models.Model):\n\n    recipient = models.EmailField(verbose_name=_('recipient'), blank=False, null=False)\n    sender = models.EmailField(verbose_name=_('sender'), blank=False, null=False)\n    subject = models.TextField(verbose_name=_('subject'), blank=False, null=False)\n    related_objects = MultipleDBGenericManyToManyField()\n\n```\n\nNamed generic m2m field DB\n--------------------------\n\nSometimes you want to name your relations. You can use ``NamedGenericManyToManyField`` for this purpose.\n\n```python\nfrom django.db import models\nfrom generic_m2m_field.models import NamedGenericManyToManyField\n\n\nclass EmailMessage(models.Model):\n\n    recipient = models.EmailField(verbose_name=_('recipient'), blank=False, null=False)\n    sender = models.EmailField(verbose_name=_('sender'), blank=False, null=False)\n    subject = models.TextField(verbose_name=_('subject'), blank=False, null=False)\n    related_objects = NamedGenericManyToManyField()\n\n```\n\nNow you can set relations with names:\n\n\n```python\nfrom django.contrib.auth.models import User\n\nuser1, user2 = User.objects.all()\n\nemail_message = EmailMessage.objects.first()\n\n# Add user1 and user2\nemail_message.related_objects.add(author=user1)\nemail_message.related_objects.add(watcher=user2)\n\n# Read author and watcher\nemail_message.related_objects.author  # return user1\nemail_message.related_objects.watcher  # return user2\nemail_message.related_objects.to_dict()  # return dict(author=user1, watcher=user2) \n\n# Remove watcher\nemail_message.related_objects.remove(['watcher'])\n\n# Clear all relations\nemail_message.related_objects.clear()\n\n# Set relations\nemail_message.related_objects.set(author=user2)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdruids%2Fdjango-generic-m2m-field","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdruids%2Fdjango-generic-m2m-field","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdruids%2Fdjango-generic-m2m-field/lists"}