1
0
mirror of https://github.com/peeringdb/peeringdb.git synced 2024-05-11 05:55:09 +00:00
Files
peeringdb-peeringdb/docs/dev/modules/geo.py.md
Matt Griswold e2619a001f Support 202201 (#1111)
* remove survey notifications

* substantially rate limit unauthenticated /api/ queries to encourage authenticated queries #853

* move api throttle class configuration to settings (#853)

* #722 with a more generic validation approach

* Add organisations and registered users to "Global System Statistics" in footer #620

* poetry relock

* linting

* regen docs

* fix test data

Co-authored-by: Stefan Pratter <stefan@20c.com>
Co-authored-by: David Poarch <dpoarch@20c.com>
2022-02-08 13:14:27 -06:00

1.5 KiB

Generated from geo.py on 2022-02-07 09:42:46.681191

peeringdb_server.geo

Utilities for geocoding and geo normalization.

Classes


Melissa

Melissa(builtins.object)

Handle requests to the melissa global address service used for geocoding and address normalization.

Methods

_init_

def __init__(self, key, timeout=5)

Initialize self. See help(type(self)) for accurate signature.


global_address

def global_address(self, **kwargs)

Send request to the global address service.

Keyword arguments:

  • address1
  • address2
  • city
  • country
  • zipcode

sanitize

def sanitize(self, **kwargs)

Take an international address and sanitize it using the melissa global address service.


sanitize_address_model

def sanitize_address_model(self, instance)

Take an instance of AddressModel and run its address through the normalization process.

Note that this will not actually change fields on the instance.

Return dict with normalized address data and geo coordinates.


NotFound

NotFound(builtins.OSError)

Base class for I/O related errors.

RequestError

RequestError(builtins.OSError)

Base class for I/O related errors.

Methods

_init_

def __init__(self, exc)

Initialize self. See help(type(self)) for accurate signature.


Timeout

Timeout(builtins.OSError)

Base class for I/O related errors.

Methods

_init_

def __init__(self)

Initialize self. See help(type(self)) for accurate signature.