Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs on how to use the library? #18

Open
piskvorky opened this issue Jun 1, 2017 · 8 comments
Open

Docs on how to use the library? #18

piskvorky opened this issue Jun 1, 2017 · 8 comments

Comments

@piskvorky
Copy link

piskvorky commented Jun 1, 2017

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
Copy link

gaskyk commented Jun 28, 2017

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

@srevenant
Copy link

yep

@ymz1124
Copy link

ymz1124 commented Nov 28, 2017

agree with @piskvorky

@EvaSDK
Copy link
Contributor

EvaSDK commented Nov 28, 2017

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
Copy link

agree with @piskvorky as well

@dhk
Copy link

dhk commented Oct 31, 2018

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

@thaichat04
Copy link

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
Copy link

the docs seem to be unavailable now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

10 participants