From 767c03a621994d4f6633a2e6750e67000824d040 Mon Sep 17 00:00:00 2001 From: Michell Stuttgart Date: Sat, 30 Mar 2019 14:55:45 -0300 Subject: [PATCH] [NEW] Atualiza README para markdown --- README.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 86 -------------------------------------------------- 2 files changed, 92 insertions(+), 86 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..fde5866 --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ + +

+
+ + +
+ PySIGEP +
+

+ +

Interface python para uso dos serviços fornecidos pelo SIGEPWeb dos Correios.

+ +

+ + Version + + + Installs + + + Ratings + + + Ratings + + + Ratings + +

+ +

+ Sobre | + Recursos | + Documentação | + Instalação | + Como Contribuir | + Créditos +

+ + +## 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 diff --git a/README.rst b/README.rst deleted file mode 100644 index 76adb4b..0000000 --- a/README.rst +++ /dev/null @@ -1,86 +0,0 @@ -======= -PySIGEP -======= - -.. image:: https://img.shields.io/travis/mstuttgart/pysigep/develop.svg?style=flat-square - :target: https://travis-ci.org/mstuttgart/pysigep - -.. image:: https://img.shields.io/coveralls/mstuttgart/pysigep/develop.svg?style=flat-square - :target: https://coveralls.io/github/mstuttgart/pysigep?branch=develop - -.. image:: https://landscape.io/github/mstuttgart/pysigep/develop/landscape.svg?style=flat-square - :target: https://landscape.io/github/mstuttgart/pysigep/develop - -.. image:: https://img.shields.io/pypi/v/pysigep.svg?style=flat-square - :target: https://pypi.python.org/pypi/pysigep - -.. image:: https://img.shields.io/pypi/pyversions/pysigep.svg?style=flat-square - :target: https://pypi.python.org/pypi/pysigep - -.. image:: https://img.shields.io/pypi/l/pysigep.svg?style=flat-square - :target: https://github.com/mstuttgart/pysigep/blob/develop/LICENSE - -Interface python para uso dos serviços fornecidos pelo SIGEPWeb dos Correios. - -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. - -Features --------- - -- 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 `_ - -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. - -.. code-block:: shell - - 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 `_. - -Contribuidores --------------- - -Agradecimentos aos seguintes contribuidores pelo esforço de fazer a PyCEPCorreios -melhor: - -- Lista de contribuidores: https://github.com/mstuttgart/pysigep/graphs/contributors - - -Créditos --------- - -Copyright (C) 2016-2018 por Michell Stuttgart