README 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. Django PostgreSQL Netfilters
  2. ============================
  3. This project is an attempt at making proper Django net related fields for Django
  4. Currently the built in IPAddressField does not support IPv6 and uses an inefficient
  5. HOST() cast in all lookups. Hopefully there experience from this project can lead
  6. to a resolution of these issues upstream.
  7. In addition to the basic IPAddressField replacement a CIDR and MAC field have
  8. been added. Furthermore a customer Manager allows for access to all of PostgreSQL's
  9. INET operators.
  10. Getting started
  11. ---------------
  12. Make sure netfields is in your PYTHONPATH, then simply use the following:
  13. from netfields import InetAddressField, NetManager
  14. class Example(models.Model):
  15. inet = InetAddressField()
  16. ...
  17. objects = NetManager()
  18. The page also provides CidrAddressField and a MACAddressField. NetManger is
  19. required for the extra lookups to be available. Lookups for INET and CIDR
  20. database types will be handled differently than when running vanilla Django.
  21. All lookups are case-insensitive and text based lookups are avoided whenever
  22. possible. In addition to Django's default lookup types the following have been
  23. added.
  24. __net_contained
  25. __net_contained_or_equal
  26. __net_contains
  27. __net_contains_or_equals
  28. These correspond with the operators from
  29. http://www.postgresql.org/docs/8.3/interactive/functions-net.html
  30. netfields does not have to be in INSTALLED_APPS.