semvec/pypi-packages huggingface dataset:
django-tree-materialized 0.0.6
Materialized tree for Django 3.x
License: Apache License 2.0
Requires Python: ~=3.6

Materialized tree for Django 3.x
================================

.. image:: https://github.com/kostya-ten/django_tree_materialized/workflows/Workflows/badge.svg
     :target: https://github.com/kostya-ten/django_tree_materialized/actions/
     :alt: GihHub Action

.. image:: https://requires.io/github/kostya-ten/django_tree_materialized/requirements.svg?branch=master
     :target: https://requires.io/github/kostya-ten/django_tree_materialized/requirements/?branch=master
     :alt: Requirements Status

.. image:: https://api.codacy.com/project/badge/Grade/8af689b2407342a08a42d6cb719ea51a
     :target: https://www.codacy.com/manual/kostya/django_tree_materialized?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=kostya-ten/django_tree_materialized&amp;utm_campaign=Badge_Grade
     :alt: Codacy grade

.. image:: https://badge.fury.io/py/django-tree-materialized.svg
     :target: https://badge.fury.io/py/django-tree-materialized
     :alt: pypi


Requirements
""""""""""""""""""
* Python 3.6+
* A supported version of Django (currently 3.x)

Getting It
""""""""""""""""""
You can get Django tree materialized by using pip::

    $ pip install django-tree-materialized

If you want to install it from source, grab the git repository from GitHub and run setup.py::

    $ git clone git://github.com/kostya-ten/django_tree_materialized.git
    $ cd django_tree_materialized
    $ python setup.py install


Installation
"""""""""""""
To enable ``django_tree_materialized`` in your project you need to add it to `INSTALLED_APPS` in your projects ``settings.py``

.. code-block:: python

    INSTALLED_APPS = (
        # ...
        'django_tree_materialized',
        # ...
    )


Using
"""""
Add to your ``models.py``

.. code-block:: python

    from django_tree_materialized.models import MPTree

    class YouModel(MPTree):
        name = models.CharField(max_length=200)



Simple example

.. code-block:: python

    name = models.YouModel.create(name="Name name")
    sub = models.YouModel.create(name="Name node2", parent=name)

    # Get a list of parents
    result = name.get_family() # Return QuerySet object
    for item in result:
        print(item.id, item.name, item.level, item.path, item.parent)


Method
""""""

get_family() - Get a list of parents

get_parent() - Return parent

get_root() - Return root object

move() - Moves one node to another


**Move**

.. code-block:: python

    name = models.YouModel.create(name="Name name")
    new_name = models.YouModel.create(name="Name node2")

    result = name.move(new_name) # Return QuerySet new_name object