Skip to main content

XML backed models queried from external REST apis

Project description

Build Status Coverage Status


XmlModels allows you to define Models similar in nature to Django models that are backed by XML endpoints rather than a database. Using a familiar declarative definition, the fields map to values in the XML document by means of XPath expressions. With support for querying external REST APIs using a django-esque approach, we have strived to make writing and using xml backed models as close to django database models as we can, within the limitations of the available API calls.


The simplest approach is to to use pip install xml_models2

A simple example

Just to get started, this is an example of taking an XML representation of an Address that might be returned from a GET request to an external REST api.

<Address id="2">
  <street>Acacia Avenue</street>
  <postcode>IM6 66B</postcode>

class Address(xml_models.Model):
  number = xml_models.IntField(xpath="/Address/number")
  street = xml_models.CharField(xpath="/Address/street")
  city = xml_models.CharField(xpath="/Address/city")
  country = xml_models.CharField(xpath="/Address/country")
  postcode = xml_models.CharField(xpath="/Address/postcode")

  finders = {(id,): 'http://adresses/%s'}

This example would be used as follows:-

>>> address = Address.objects.get(id=2)
>>> print "address is %s, %s" % (address.number, address.street)
"22, Acacia Avenue"


This project is a fork of Django REST Models

Project details

Download files

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

Files for xml_models2, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size xml_models2-0.8.0-py2.py3-none-any.whl (9.6 kB) File type Wheel Python version 3.4 Upload date Hashes View
Filename, size xml_models2-0.8.0.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page