Metadata-Version: 2.1
Name: djangorestframework-xml
Version: 2.0.0
Summary: XML support for Django REST Framework
Home-page: https://github.com/jpadilla/django-rest-framework-xml
Author: José Padilla
Author-email: hello@jpadilla.com
License: BSD
Description: # REST Framework XML
        
        [![build-status-image]][github-action]
        [![pypi-version]][pypi]
        
        **XML support for Django REST Framework**
        
        Full documentation for the project is available at [http://jpadilla.github.io/django-rest-framework-xml][docs].
        
        ## Overview
        
        XML support extracted as a third party package directly from the official Django REST Framework implementation. It requires the [defusedxml][defusedxml] package only because it safeguards against some security issues that were discovered.
        
        **Note**: XML output provided is an ad-hoc format that isn't formally described. If you have specific XML requirements you'll need to write your own XML parsers/renderers in order to fully control the representation.
        
        ## Requirements
        
        * Python 3.5+
        * Django 2.2+
        * Django REST Framework 3.11+
        
        ## Installation
        
        Install using `pip`...
        
        ```bash
        $ pip install djangorestframework-xml
        ```
        
        ## Example
        
        ```python
        REST_FRAMEWORK = {
            'DEFAULT_PARSER_CLASSES': (
                'rest_framework_xml.parsers.XMLParser',
            ),
            'DEFAULT_RENDERER_CLASSES': (
                'rest_framework_xml.renderers.XMLRenderer',
            ),
        }
        ```
        
        You can also set the renderer and parser used for an individual view, or viewset, using the APIView class based views.
        
        ```python
        from rest_framework import routers, serializers, viewsets
        from rest_framework_xml.parsers import XMLParser
        from rest_framework_xml.renderers import XMLRenderer
        
        
        class UserSerializer(serializers.HyperlinkedModelSerializer):
            class Meta:
                model = User
                fields = ('url', 'username', 'email', 'is_staff')
        
        
        class UserViewSet(viewsets.ModelViewSet):
            queryset = User.objects.all()
            serializer_class = UserSerializer
            parser_classes = (XMLParser,)
            renderer_classes = (XMLRenderer,)
        ```
        
        ### Sample output
        
        ```xml
        <?xml version="1.0" encoding="utf-8"?>
        <root>
            <list-item>
                <url>http://127.0.0.1:8000/users/1/.xml</url>
                <username>jpadilla</username>
                <email>jpadilla@example.com</email>
                <is_staff>True</is_staff>
            </list-item>
        </root>
        ```
        
        ## Documentation & Support
        
        Full documentation for the project is available at [http://jpadilla.github.io/django-rest-framework-xml][docs].
        
        You may also want to follow the [author][jpadilla] on Twitter.
        
        
        [build-status-image]: https://github.com/jpadilla/django-rest-framework-xml/workflows/CI/badge.svg
        [github-action]: https://github.com/jpadilla/django-rest-framework-xml/actions?query=workflow%3ACI
        [pypi-version]: https://img.shields.io/pypi/v/djangorestframework-xml.svg
        [pypi]: https://pypi.python.org/pypi/djangorestframework-xml
        [defusedxml]: https://pypi.python.org/pypi/defusedxml
        [docs]: http://jpadilla.github.io/django-rest-framework-xml
        [jpadilla]: https://twitter.com/jpadilla_
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: tests
Provides-Extra: dev
