Metadata-Version: 1.0
Name: pydawa
Version: 0.4.3
Summary: API wrapper til DAWA
Home-page: http://github.com/danielarnason/pydawa
Author: Daníel Örn Árnason
Author-email: danielarnason85@gmail.com
License: MIT
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.
        
        ### Reverse geokodning
        Hvis man har koordinater og gerne vil finde den nÃ¦rmeste adresse.
        
        ```python
        import pydawa
        
        koordinater = (12.18, 55.78)
        
        adresse = pydawa.Reverse(koordinater=koordinater)
        response = adresse.info()
        ```
        
        Geokoder
        =========
        Hvis man har en csv eller xlsx fil, som indeholder adresser, som skal geokodes, sÃ¥ kan man bruge den her. Her skal man bare pege pÃ¥ stien til filen, som skal geokodes og angive de kolonner, der indeholder adresse data.
        
        ```python
        import pydawa
        
        geokoder = pydawa.Geokoder('c:/users/brugernavn/adresser.csv', cols=['vejnavn', 'husnr', 'postnr', 'bynavn'])
        `
        Man kan vÃ¦lge om man vil fÃ¥ resultatet gemt i en fil eller bare fÃ¥ det returneret i en pandas dataframe.
        
        ```python
        # Som dataframe
        df = geokoder.geokod()
        
        # Som en fil, som bliver gemt i samme folder, som den fil, der bliver gekodet
        geokoder.geokod(save=True)
        `
Platform: UNKNOWN
