Metadata-Version: 1.1
Name: admin-extra-urls
Version: 1.7
Summary: Django mixin to easily add urls to any ModelAdmin
Home-page: https://github.com/saxix/django-admin-extra-urls
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN
Download-URL: https://pypi.python.org/pypi/admin-extra-urls
Description: admin-extra-urls
        ================
        
        
        pluggable django application that offers one single mixin class ``ExtraUrlMixin``
        to easily add new url (and related buttons on the screen) to any ModelAdmin.
        
        It provides two decorators ``link()`` and ``action()``.
        
        - ``link()`` is intended to be used for multiple records. It will produce a button in the change list view.
        
        - ``action()`` works on a single record. It will produce a button in the change form view.
        
        
        
        Install
        -------
        
        .. code-block:: python
        
            pip install admin-extra-urls
        
        
        After installation add it to ``INSTALLED_APPS``
        
        .. code-block:: python
        
        
           INSTALLED_APPS = (
               ...
               'admin_extra_urls',
           )
        
        How to use it
        -------------
        
        .. code-block:: python
        
            class MyModelModelAdmin(ExtraUrlMixin, admin.ModelAdmin):
        
                @link() # /admin/myapp/mymodel/update_all/
                def update_all(self, request):
                    ...
                    ...
        
        
                @action() # /admin/myapp/mymodel/update/10/
                def update(self, request, pk):
                    ...
                    ...
        
        You don't need to return a HttpResponse. The default behavior is:
        
            - with `link()` button is displayed in the 'list' view and the browser will be redirected to ``changelist_view``
        
            - with `action()`  button is displayed in the 'update' view and the browser will be redirected to ``change_view``
        
        
        link() / action() options
        -------------------------
        
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | path       | None                 | path url path for the action. will be the url where the button will point to.          |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | label      | None                 | label for the button. by default the "labelized" function name                         |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | icon       | ''                   | icon for the button                                                                    |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | permission | None                 | permission required to use the button. can be a callable (current object as argument). |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | css_class  | "btn btn-success"    | extra css classes to use for the button                                                |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | order      | 999                  | in case of multiple button the order to use                                            |
        +------------+----------------------+----------------------------------------------------------------------------------------+
        | visible    | lambda o: o and o.pk | callable or bool. By default do not display the button if in `add` mode                |
        +-----------------------------------+----------------------------------------------------------------------------------------+
        
        
        *Note*
        
            The package contains a ``UploadMixin`` to manage custom file uploads
            (simply set `upload_handler` to a function.
            This can be checked to see how to create wizard with an intermediate form.
        
        
        Links
        ~~~~~
        
        +--------------------+----------------+--------------+-----------------------------+
        | Stable             | |master-build| | |master-cov| |                             |
        +--------------------+----------------+--------------+-----------------------------+
        | Development        | |dev-build|    | |dev-cov|    |                             |
        +--------------------+----------------+--------------+-----------------------------+
        | Project home page: |https://github.com/saxix/django-admin-extra-urls             |
        +--------------------+---------------+---------------------------------------------+
        | Issue tracker:     |https://github.com/saxix/django-admin-extra-urls/issues?sort |
        +--------------------+---------------+---------------------------------------------+
        | Download:          |http://pypi.python.org/pypi/django-admin-extra-urls/         |
        +--------------------+---------------+---------------------------------------------+
        
        
        .. |master-build| image:: https://secure.travis-ci.org/saxix/django-admin-extra-urls.png?branch=master
                            :target: http://travis-ci.org/saxix/django-admin-extra-urls/
        
        .. |master-cov| image:: https://coveralls.io/repos/saxix/django-admin-extra-urls/badge.png?branch=master
                            :target: https://coveralls.io/r/saxix/django-admin-extra-urls
        
        
        .. |dev-build| image:: https://secure.travis-ci.org/saxix/django-admin-extra-urls.png?branch=develop
                          :target: http://travis-ci.org/saxix/django-admin-extra-urls/
        
        .. |dev-cov| image:: https://coveralls.io/repos/saxix/django-admin-extra-urls/badge.png?branch=develop
                        :target: https://coveralls.io/r/saxix/django-admin-extra-urls
        
        
        .. |python| image:: https://pypip.in/py_versions/admin-extra-urls/badge.svg
            :target: https://pypi.python.org/pypi/admin-extra-urls/
            :alt: Supported Python versions
        
        .. |pypi| image:: https://pypip.in/version/admin-extra-urls/badge.svg?text=version
            :target: https://pypi.python.org/pypi/admin-extra-urls/
            :alt: Latest Version
        
        .. |license| image:: https://pypip.in/license/admin-extra-urls/badge.svg
            :target: https://pypi.python.org/pypi/admin-extra-urls/
            :alt: License
        
        .. image:: https://pypip.in/wheel/admin-extra-urls/badge.svg
            :target: https://pypi.python.org/pypi/admin-extra-urls/
            :alt: Wheel Status
        
        .. |travis| image:: https://travis-ci.org/saxix/django-admin-extra-urls.svg?branch=develop
            :target: https://travis-ci.org/saxix/django-admin-extra-urls
        
        .. |django| image:: https://img.shields.io/badge/Django-1.8-orange.svg
            :target: http://djangoproject.com/
            :alt: Django 1.7, 1.8
        
Platform: linux
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
