search

scaleway / postal-address

:postal_horn: Parse, normalize and render postal addresses.
https://postal-address.readthedocs.io
Other
183 stars 16 forks source link

Docs on how to use the library? #18

Open piskvorky opened 7 years ago

piskvorky commented 7 years ago

Hi, the lib intro sounds great, but I couldn't find any doc examples on how to actually use it.

There's the API documentation at https://postal-address.readthedocs.io/en/develop/ , which is quite detailed and contains a myriad of classes and methods, but not helpful in figuring out what to do.

Is there a quick start example or something? How do I detect addresses in text using postal-address?

Apologies if I missed something obvious.

gaskyk commented 7 years ago

I agree with @piskvorky . I've just installed this package but unsure where I go from here. Thanks.

srevenant commented 6 years ago

yep

ymz1124 commented 6 years ago

agree with @piskvorky

EvaSDK commented 6 years ago

Afaiu, current code limits itself to validating already split input data (line1, line2, postal_code, city_name) and formatting it. There is no address detection feature that I could see in the source code.

KyleHaynes commented 5 years ago

agree with @piskvorky as well

dhk commented 5 years ago

I'd be happy to write some docs/annotated examples if the owner could provide a use-case I can run with.

thaichat04 commented 5 years ago

Afaiu, current code limits itself to validating already split input data (line1, line2, postal_code, city_name) and formatting it. There is no address detection feature that I could see in the source code.

That leads us to misunderstand the function of this module: this help ready parsing/extract address from full text or not ?

kotoroshinoto commented 2 years ago

the docs seem to be unavailable now