File: README.md

package info (click to toggle)
python-django-treebeard 4.5.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 1,588 kB
  • sloc: python: 5,223; javascript: 257; makefile: 184; sh: 6
file content (45 lines) | stat: -rw-r--r-- 1,752 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# django-treebeard

**django-treebeard** is a library that implements efficient tree
implementations for the Django Web Framework 2.2 and later.

It is written by Gustavo Picón and licensed under the Apache License
2.0.

## Status

[![Documentation Status](https://readthedocs.org/projects/django-treebeard/badge/?version=latest)](https://django-treebeard.readthedocs.io/en/latest/?badge=latest)
[![Travis CI](https://travis-ci.org/django-treebeard/django-treebeard.svg?branch=master)](https://travis-ci.org/django-treebeard/django-treebeard)
[![App Veyor](https://ci.appveyor.com/api/projects/status/mwbf062v68lhw05c?svg=true)](https://ci.appveyor.com/project/mvantellingen/django-treebeard)
[![PyPI](https://img.shields.io/pypi/pyversions/django-treebeard.svg)]()
[![PyPI version](https://img.shields.io/pypi/v/django-treebeard.svg)](https://pypi.org/project/django-treebeard/)


## Features

django-treebeard is:

-   **Flexible**: Includes 3 different tree implementations with the
    same API:
    1.  Adjacency List
    2.  Materialized Path
    3.  Nested Sets
-   **Fast**: Optimized non-naive tree operations
-   **Easy**: Uses Django Model Inheritance with abstract classes to
    define your own models.
-   **Clean**: Testable and well tested code base. Code/branch test
    coverage is above 96%. Test suite running on different versions of
    Python and Django:
    <https://travis-ci.org/django-treebeard/django-treebeard/>

You can find the documentation in

> <http://django-treebeard.readthedocs.io/en/latest/>

### Supported versions

**django-treebeard** officially supports

-   Django 2.2 - 3.1
-   Python 3.6, 3.7, 3.8, 3.9
-   PostgreSQL, MySQL, MSSQL, SQLite database back-ends.