olist / correios

A client library for Brazilian Correios APIs and services (SIGEP & SRO).
Apache License 2.0
171 stars 44 forks source link

Add Examples #18

Open rturk opened 8 years ago

rturk commented 8 years ago

It would be nice to include some examples:

ayharano commented 7 years ago

Commenting here because I'm just trying to understand...

How should the requested examples be written? More specifically, where?

I looked up documentation and samples directories. documentation has a list of mixed file extensions while samples has one python source code without comments related to which kind of code it should be.

Please, guide us at least to know where we should create/modify the files and which is the expected format for the requested examples.

osantana commented 7 years ago

How should the requested examples be written? More specifically, where?

Small script in "samples" directory to shipping cost calculation, shipping labels PDF generation, ~tracking code request~, object tracking, etc.

I looked up documentation and samples directories. documentation has a list of mixed file extensions while samples has one python source code without comments related to which kind of code it should be.

I'll rename "documentation" -> "references". There is an other issue (#100) for documentation.

tiagovizoto commented 6 years ago

Essa isso está aberta? Is open this issues?

osantana commented 6 years ago

Yes. It's still open

tiagovizoto commented 6 years ago

Eu posso fazer algo bem por cima. Pois não possuo acesso ao sistema de serviços dos correios. Pode ser? I can do something basic, me not have access the resources of Correios. Ok?

osantana commented 6 years ago

There is an staging environment for tests "homolog" that you can set when instantiating the client class.

jonyw4 commented 4 years ago

Pessoal tentei usar a pasta de docs para gerar a documentação mas está vazia. Conheci o repositório hoje, gostaria de usa-lo e contribuir. Na pasta samples tem apenas um exemplo. Vocês tem algum arquivo de exemplo com mais funcionalidade ou alguma documentação funcional?