https://github.com/mariocesar/django-ltree

An ltree extension implementation to support hierarchical tree-like data using the native Postgres extension ltree in django models
https://github.com/mariocesar/django-ltree

django ltree postgresql-extension

Last synced: 1 day ago
JSON representation

An ltree extension implementation to support hierarchical tree-like data using the native Postgres extension ltree in django models

• Host: GitHub
• URL: https://github.com/mariocesar/django-ltree
• Owner: mariocesar
• License: mit
• Created: 2018-10-06T14:12:09.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-19T22:32:59.000Z (15 days ago)
• Last Synced: 2024-12-26T10:07:57.305Z (9 days ago)
• Topics: django, ltree, postgresql-extension
• Language: Python
• Homepage: https://pypi.org/project/django-ltree/
• Size: 95.7 KB
• Stars: 61
• Watchers: 2
• Forks: 15
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# django-ltree

A tree extension implementation to support hierarchical tree-like data in Django models,

using the native Postgres extension `ltree`.

Postgresql has already a optimized and very useful tree implementation for data.

The extension is [ltree](https://www.postgresql.org/docs/9.6/static/ltree.html)

This fork contains a backport to Django 1.11 and Python 3.6.

[![Test](https://github.com/mariocesar/django-ltree/actions/workflows/test.yml/badge.svg)](https://github.com/mariocesar/django-ltree/actions/workflows/test.yml)

## Links

 - Pypi https://pypi.org/project/django-ltree/

 - Source code https://github.com/mariocesar/django-ltree

 - Bugs https://github.com/mariocesar/django-ltree/issues

 - Contribute https://github.com/mariocesar/django-ltree/pulls

 - Documentation `TODO`

## Install

```

pip install django-ltree

```

Then add `django_ltree` to `INSTALLED_APPS` in your Django project settings.

And make sure to run `django_ltree` migrations before you added the `PathField`

```

python manage.py migrate django_ltree

```

`django_ltree` migrations will install the `ltree` extension if not exist.

You can alternatively specify the `django_ltree` dependency in the migrations of

your applications that requires `PathField`, and run migrations smoothly.

```

class Migration(migrations.Migration):

    dependencies = [

            ('django_ltree', '__latest__'),

    ]

```

## Requires

- Django 1.11 or superior

- Python 2

## Testing

Make sure you have Postgres installed. Then simply run `tox` in the root directory of the project.