https://github.com/roverdotcom/django-related-models

An easy way to fetch all the related objects of a Django model's instance.
https://github.com/roverdotcom/django-related-models

Last synced: 6 months ago
JSON representation

An easy way to fetch all the related objects of a Django model's instance.

• Host: GitHub
• URL: https://github.com/roverdotcom/django-related-models
• Owner: roverdotcom
• License: bsd-3-clause
• Created: 2018-09-07T12:41:23.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-01-03T21:33:47.000Z (over 4 years ago)
• Last Synced: 2025-01-30T09:47:33.855Z (over 1 year ago)
• Language: Python
• Size: 27.3 KB
• Stars: 1
• Watchers: 65
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - docs

      - |docs|

    * - tests

        | |github-tests|

        | |codecov|

    * - package

      - | |version| |wheel| |supported-versions| |supported-implementations|

        | |commits-since|

.. |docs| image:: https://readthedocs.org/projects/django-related-models/badge/?version=latest

    :target: https://django-related-models.readthedocs.io/en/latest/?badge=latest

    :alt: Documentation Status

.. |codecov| image:: https://codecov.io/github/roverdotcom/django-related-models/coverage.svg?branch=master

    :alt: Coverage Status

    :target: https://codecov.io/github/roverdotcom/django-related-models

.. |version| image:: https://img.shields.io/pypi/v/django-related-models.svg

    :alt: PyPI Package latest release

    :target: https://pypi.python.org/pypi/django-related-models

.. |commits-since| image:: https://img.shields.io/github/commits-since/roverdotcom/django-related-models/v0.1.1.svg

    :alt: Commits since latest release

    :target: https://github.com/roverdotcom/django-related-models/compare/v0.1.1...master

.. |wheel| image:: https://img.shields.io/pypi/wheel/django-related-models.svg

    :alt: PyPI Wheel

    :target: https://pypi.python.org/pypi/django-related-models

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/django-related-models.svg

    :alt: Supported versions

    :target: https://pypi.python.org/pypi/django-related-models

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/django-related-models.svg

    :alt: Supported implementations

    :target: https://pypi.python.org/pypi/django-related-models

.. |github-tests| image:: https://github.com/roverdotcom/django-related-models/actions/workflows/build/badge.svg

    :alt: GitHub build status

    :target: https://github.com/roverdotcom/django-related-models/

.. end-badges

A library designed such that, when provided with a model instance it will return a QuerySet for the rows that are

associated with that model instance. It also works well with ``GenericForeignKey`` objects.

.. code:: python

    >>> eminem = Artist.objects.filter(stage_name='Eminem').first()

    >>> list(get_related_objects(eminem))

    [, , ]

    >>> get_related_objects_mapping(eminem)

    {: set([]),

    : set([]),

    : set([])}

Installation

============

::

    pip install django-related-models

Documentation

=============

https://django-related-models.readthedocs.io/

Development

===========

The tests are run via **tox**, which you would need to install (if you don't already have it).

* To get tox just::

    pip install tox

* To run the all tests run::

    tox