README.rst 942 Bytes
Newer Older
Gustavo Picon's avatar
Gustavo Picon committed
1

Gustavo Picon's avatar
Gustavo Picon committed
2 3 4
django-treebeard
================

Gustavo Picon's avatar
Gustavo Picon committed
5
django-treebeard is a library that implements efficient tree implementations
6
for the Django Web Framework 1.6+, written by Gustavo Picón and licensed under
Gustavo Picon's avatar
Gustavo Picon committed
7
the Apache License 2.0.
Gustavo Picon's avatar
Gustavo Picon committed
8

Gustavo Picon's avatar
Gustavo Picon committed
9
django-treebeard is:
10

Gustavo Picon's avatar
Gustavo Picon committed
11 12 13 14 15 16
- **Flexible**: Includes 3 different tree implementations with the same API:

  1. Adjacency List
  2. Materialized Path
  3. Nested Sets

17
- **Fast**: Optimized non-naive tree operations
Gustavo Picon's avatar
Gustavo Picon committed
18 19 20
- **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
Gustavo Picon's avatar
Gustavo Picon committed
21 22 23 24 25
  96%. Tests are available in Jenkins:

  - Test suite running on different versions of Python, Django and database
    engine: https://tabo.pe/jenkins/job/django-treebeard/
  - Code quality: https://tabo.pe/jenkins/job/django-treebeard-quality/
Gustavo Picon's avatar
Gustavo Picon committed
26 27 28

You can find the documentation in

Gustavo Picon's avatar
Gustavo Picon committed
29
    https://tabo.pe/projects/django-treebeard/docs/tip/