Metadata-Version: 1.1
Name: django-alacarte
Version: 0.1.31
Summary: A minimalist Django menu app.
Home-page: https://github.com/mstrcnvs/django-alacarte
Author: Rafael Canovas
Author-email: rafaelcanovas@me.com
License: UNKNOWN
Description: Alacarte
        ========
        
        ``django-alacarte`` is a minimalist menu app for Django.
        
        Installation
        ------------
        
        .. code:: bash
        
            $ pip install django-alacarte
        
        Usage
        -----
        
        Add "alacarte" to your *INSTALLED\_APPS*:
        
        .. code:: python
        
            INSTALLED_APPS = (
                ...,
                'alacarte',
            )
        
        In your root *urls.py* add the following code:
        
        .. code:: python
        
            # ...
        
            import alacarte
            alacarte.autodiscover()
        
            # Your url patterns
        
        Alacarte uses that to automatically discover and load *menu.py* files
        inside each one of your *INSTALLED\_APPS*.
        
        Create a file called *menu.py* inside the app of your choice and
        register its corresponding menus:
        
        .. code:: python
        
            import alacarte
        
        
            class BankTransactionsMenu(alacarte.Menu):
                label = 'Transactions'
                url_name = 'bank_transactions'
        
        
            class BankBalanceMenu(alacarte.Menu):
                label = 'Balance'
                url_name = 'bank_balance'
        
        
            class BankPremiumMenu(alacarte.Menu):
                label = 'Premium Offers'
                url_name = 'bank_premium_offers'
        
                def shown(self)
                    user = self.context['user']
                    return user.is_premium()
        
        
            class BankMenu(alacarte.Menu):
                group = 'main'
                label = 'Bank'
                submenus = (
                    BankTransactionsMenu(),
                    BankBalanceMenu(),
                    BankPremiumMenu(),
                )
        
                def shown(self):
                    user = self.context['user']
                    return user.is_authenticated()
        
        
            alacarte.register(BankMenu)
        
        Then in your template:
        
        .. code:: django
        
            {% load alacarte %}
            {# ... #}
                {# ... #}
                {% alacarte "main" %}
                {# ... #}
            {# ... #}
        
        --------------
        
        ``django-alacarte`` is not related to
        https://pypi.python.org/pypi/alacarte
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
