Skip to main content

Heirarchical categories/taxonomies for your Django project

Project description

https://travis-ci.org/aldryn/aldryn-categories.svg?branch=master https://coveralls.io/repos/aldryn/aldryn-categories/badge.svg https://pypip.in/v/aldryn-categories/badge.svg https://pypip.in/d/aldryn-categories/badge.svg https://pypip.in/wheel/aldryn-categories/badge.svg https://pypip.in/license/aldryn-categories/badge.svg

Aldryn Categories

Description

Aldryn Categories is a simple project that provides hierarchical categories as an independent model in your project. Categories are similar to tags, but are structured into a taxonomy. The project is suitable for I18N projects as Categories are fully translatable.

Dependencies/Support

  1. Python v2.7+

  2. Django v1.6.x + South v1.0.2+ (see note below) or Django v1.7+

  3. django-treebeard v2.0+

  4. django-parler v1.2.1+

If you’re using Django 1.6 with South and you cannot upgrade to version 1.0.3 or later, then try adding this to your settings:

MIGRATION_MODULES = {
    …
    'aldryn_categories': 'aldryn_categories.south_migrations',
    …
}

Installation & Usage

Aldryn Platform Users

  1. Choose a site you want to install the add-on to from the dashboard.

  2. Go to Apps -> Install App

  3. Click Install next to Categories app.

  4. Redeploy the site.

Manual Installation

  1. Run pip install aldryn-categories. Or directly from the GitHub repository with: pip install https://github.com/aldryn/aldryn-categories/archive/master.zip

  2. Add the following to your INSTALLED_APPS:

    INSTALLED_APPS = [
        …
        'aldryn_categories',
        'treebeard',
        …
    ]

    Treebeard must be in your INSTALLED_APPS settings in order for the correct admin templates to be available.

  3. Now, add a CategoryManyToManyField to aldryn_categories.Category on any models you wish to categorize, like so:

    # -*- coding: utf-8 -*-
    
    from django.db import models
    from aldryn_categories.fields import CategoryManyToManyField
    
    class Thing(models.Model):
        my_field = models.CharField(...)
        ...
        categories = CategoryManyToManyField('aldryn_categories.Category')

This usage of the CategoryManyToManyField simply allows your categories to be displayed heirarchically in the otherwise normal MultipleSelectWidget like so:

diagrams/category-widget-preview.png

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aldryn-categories-0.1.2.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

aldryn_categories-0.1.2-py2-none-any.whl (12.4 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page