API wrapper til DAWA
Project description
PyDawa
======
En simple API wrapper omkring Danmarks Adressers Web API (DAWA).
Formålet med dette modul er at give nem adgang til DAWA i Python. Grunden til, at jeg begyndte at arbejde på dette modul er, at jeg havde skrevet et par scripts i python, der brugte API'et, men der var ingen "nem" adgang til det. Plus, jeg var nysgerrig over, om jeg kunne skrive et modul og uploade til pypi.
Det her projekt er et "work in progress", så jeg kommer til at tilføje funktionalitet, når jeg har brug for den. Jeg håber, at folk har lyst til at hjælpe med det.
Afhængigheder
* Requests
Installation
----
Installer med pip:
```$ pip install pydawa```
Brug
-----
Indtil videre, består modulet kun af tre classer:
1. Adressesoeg
2. Adresseopslag
3. Adressevasker
### Adressesoeg()
Søg efter en adresse med vejnavn, husnr og postnummer.
```python
import pydawa
adresse = pydawa.Adressesoeg(vejnavn='Dronning Dagmars vej', husnr='200', postnr='3650')
response = adresse.info()
```
`info()` metoden henter data fra dawa api'et og returnerer en dictionary med respons.
Man kan også søge med en tekststring.
```python
import pydawa
adresse = pydawa.Adressesoeg(q='Dronning Dagmars Vej 200, 3650 Ølstykke')
response = adresse.info()
```
### Adresseopslag
Søg efter en adresse med adressens unikke id.
```python
import pydawa
adresse = pydawa.Adresseopslag(id=id)
response = adresse.info()
```
`info()` metoden henter data fra dawa api'et og returnerer en dictionary med respons.
### Adressevasker
Datavask af adressebetegnelse. Modtager en adressebetegnelse og returnerer en eller flere adresser, der bedst matcher.
```python
import pydawa
adresse = pydawa.Adressevasker(betegnelse=adressebetegnelse)
response = adresse.info()
```
### Koordinater for adresser
Man kan hente koordinater for en given adresse ved at bruge _get_koordinater_ metoden fra _adresse_ variablen i examplerne ovenfor.
```python
import pydawa
adresse = pydawa.Adresseopslag(id=id)
response = adresse.info()
koordinater = adresse.get_koordinater(response[0])
```
Den metode tager et json object. Indtil videre se returner både _Adressesoeg_ og _Adresseopslag_ en liste, så derfor bruger man _response[0]_ som input.
Man kan kun hente koordinater fra _Adressesoeg_ og _ Adresseopslag_, fordi _Adressevasker_ returnerer ikke koordinater.
======
En simple API wrapper omkring Danmarks Adressers Web API (DAWA).
Formålet med dette modul er at give nem adgang til DAWA i Python. Grunden til, at jeg begyndte at arbejde på dette modul er, at jeg havde skrevet et par scripts i python, der brugte API'et, men der var ingen "nem" adgang til det. Plus, jeg var nysgerrig over, om jeg kunne skrive et modul og uploade til pypi.
Det her projekt er et "work in progress", så jeg kommer til at tilføje funktionalitet, når jeg har brug for den. Jeg håber, at folk har lyst til at hjælpe med det.
Afhængigheder
* Requests
Installation
----
Installer med pip:
```$ pip install pydawa```
Brug
-----
Indtil videre, består modulet kun af tre classer:
1. Adressesoeg
2. Adresseopslag
3. Adressevasker
### Adressesoeg()
Søg efter en adresse med vejnavn, husnr og postnummer.
```python
import pydawa
adresse = pydawa.Adressesoeg(vejnavn='Dronning Dagmars vej', husnr='200', postnr='3650')
response = adresse.info()
```
`info()` metoden henter data fra dawa api'et og returnerer en dictionary med respons.
Man kan også søge med en tekststring.
```python
import pydawa
adresse = pydawa.Adressesoeg(q='Dronning Dagmars Vej 200, 3650 Ølstykke')
response = adresse.info()
```
### Adresseopslag
Søg efter en adresse med adressens unikke id.
```python
import pydawa
adresse = pydawa.Adresseopslag(id=id)
response = adresse.info()
```
`info()` metoden henter data fra dawa api'et og returnerer en dictionary med respons.
### Adressevasker
Datavask af adressebetegnelse. Modtager en adressebetegnelse og returnerer en eller flere adresser, der bedst matcher.
```python
import pydawa
adresse = pydawa.Adressevasker(betegnelse=adressebetegnelse)
response = adresse.info()
```
### Koordinater for adresser
Man kan hente koordinater for en given adresse ved at bruge _get_koordinater_ metoden fra _adresse_ variablen i examplerne ovenfor.
```python
import pydawa
adresse = pydawa.Adresseopslag(id=id)
response = adresse.info()
koordinater = adresse.get_koordinater(response[0])
```
Den metode tager et json object. Indtil videre se returner både _Adressesoeg_ og _Adresseopslag_ en liste, så derfor bruger man _response[0]_ som input.
Man kan kun hente koordinater fra _Adressesoeg_ og _ Adresseopslag_, fordi _Adressevasker_ returnerer ikke koordinater.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pydawa-0.3.0.tar.gz
(3.5 kB
view hashes)