Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Commit

Permalink
[NEW] Atualiza README para markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
mstuttgart committed Mar 30, 2019
1 parent 7d517a8 commit 767c03a
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 86 deletions.
92 changes: 92 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@

<h1 align="center">
<br>
<a href="https://pypi.org/project/pysigep/">
<img src="https://raw.githubusercontent.com/mstuttgart/pycep-correios/develop/docs/_static/logo.jpg" width="30%"></a>
<br>
PySIGEP
<br>
</h1>

<h4 align="center">Interface python para uso dos serviços fornecidos pelo SIGEPWeb dos Correios.</h4>

<p align="center">
<a href="https://travis-ci.org/mstuttgart/pysigep">
<img src="https://img.shields.io/travis/mstuttgart/pysigep/develop.svg?style=flat-square" alt="Version">
</a>
<a href="https://coveralls.io/github/mstuttgart/pysigep?branch=develop">
<img src="https://img.shields.io/coveralls/mstuttgart/pysigep/develop.svg?style=flat-square" alt="Installs">
</a>
<a href="https://landscape.io/github/mstuttgart/pysigep/develop">
<img src="https://landscape.io/github/mstuttgart/pysigep/develop/landscape.svg?style=flat-square" alt="Ratings">
</a>
<a href="https://pypi.org/project/pysigep">
<img src="https://img.shields.io/pypi/v/pysigep.svg?style=flat-square" alt="Ratings">
</a>
<a href="https://pypi.org/project/pysigep/">
<img src="https://img.shields.io/pypi/pyversions/pysigep.svg?style=flat-square" alt="Ratings">
</a>
</p>

<p align="center">
<a href="#sobre">Sobre</a> |
<a href="#recursos">Recursos</a> |
<a href="#documentação">Documentação</a> |
<a href="#instalação">Instalação</a> |
<a href="#como-contribuir">Como Contribuir</a> |
<a href="#créditos">Créditos</a>
</p>


## Sobre

O SIGEP WEB é um sistema com o propósito de preparar e gerenciar
as postagens de Clientes dos Correios. Seus principais atributos técnicos são:
facilidade e rapidez na preparação das postagens e gestão das informações sobre os objetos postados.

## Recursos

- Verificar *status* de um Cartão de Postagem
- Obter dados do endereço a partir de seu respectivo CEP.
- Verificar disponibilidade de um dado serviço.
- Gerar etiquetas para postagem de mercadoria.

## Documentação

Para mais detalhes sobre a PyCEPCorreios, por gentileza, consulte a documentação oficial (também disponível em Inglẽs):

* Documentação online: https://pysigep.readthedocs.io.
* Documentação PDF: [download](https://media.readthedocs.org/pdf/pysigep/stable/pysigep.pdf).

## Instalação

A versão atual **ainda esta em fase de desenvolvimento**, sendo que os recursos
disponiveis podem ser removidos sem aviso prévio. Portanto, não é recomendável
seu uso em ambiente de produção.

> pip install pysigep
### Aviso de *bugs*, dúvidas e sugestões

Para dúvidas, sugestões e relatórios de *bugs*, por gentileza, crie uma *issue*:

- Issue Tracker: https://github.com/mstuttgart/pysigep/issues

## Como Contribuir

Deseja participar do desenvolvimento da PyCepCorreios? Torne-se um contribuidor do PyCEPCorreios!
visite a documentação para verificar a *guideline* de contribuição:

- Veja [aqui](https://pysigep.readthedocs.io/pt/latest/contributing.html).

### Contribuidores

Agradecimentos aos seguintes contribuidores pelo esforço de fazer a PyCEPCorreios
melhor:

- Lista de contribuidores: [aqui](https://github.com/mstuttgart/pysigep/graphs/contributors).


## Créditos

Copyright (C) 2016-2019 por Michell Stuttgart
86 changes: 0 additions & 86 deletions README.rst

This file was deleted.

0 comments on commit 767c03a

Please sign in to comment.