[IMP] Atualiza doc. para utilizar github pages

docs/usage.rst → docs/README.md

@@ -1,33 +1,77 @@
-==========
-Utilizaçã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
+<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="#sobre">Sobre</a> |
+  <a href="#recursos">Recursos</a> |
+  <a href="#instalação">Instalação</a> |
+  <a href="#utilização">Utilizaçã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.
+
+## 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. 
+
+Atualmente, a PySIGEP possui suporte para Python 3.5+.
+
+> pip install pysigep
+
+#### A partir do código fonte
+
+Você pode realizar o *clone* do repositório público:
+
+> git clone https://github.com/mstuttgart/pysigep.git
+
+Uma vez que você tenha uma cópia do código fonte, você pode instalá-lo com:
+
+> python setup.py install
+
+## Utilizaçã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.
 
 PySigep no momento possui suporte para os seguintes serviços providos pelo SigepWeb:
 
-
 * consultaCEP
 * verificaDisponibilidadeServico
 * getStatusCartaoPostagem
 * solicitaEtiquetas
 * geraDigitoVerificadorEtiquetas
 
-Novos serviços serão implementados futuramente. A seguir temos alguns exemplos de utilização da `pysigep`. Para mais detalhes 
-sobre os serviçoes fornecidos, por favor, consulte o Manual do SigepWeb.
-
-SOAPClient
-----------
+Novos serviços serão implementados futuramente. A seguir temos alguns exemplos de utilização da `pysigep`. Para mais detalhes sobre os serviçoes fornecidos, por favor, consulte o Manual do SigepWeb.
 
-A grande maioria dos serviços do SigepWeb, exigem um cadastro de *usuário* e *senha*. De modo a tornar mais prático
-a consulta, foi desenvolvido uma classe para armazenar estes dados durante o uso da biblioteca. Sendo assim, 
-antes de qualquer consulta devemos criar um objeto `SOAPClient`.
+#### SOAPClient
 
-.. code-block:: python
+A grande maioria dos serviços do SigepWeb, exigem um cadastro de *usuário* e *senha*. De modo a tornar mais prático a consulta, foi desenvolvido uma classe para armazenar estes dados durante o uso da biblioteca. Sendo assim, antes de qualquer consulta devemos criar um objeto `SOAPClient`.
 
-    from pysigep.utils import HOMOG_USUARIO, HOMOG_SENHA, HOMOLOGACAO
+```python
+from pysigep.utils import HOMOG_USUARIO, HOMOG_SENHA, HOMOLOGACAO
 
     # Criamos o cliente SOAP
     cliente = SOAPClient(ambiente=HOMOLOGACAO,
@@ -36,9 +80,9 @@ antes de qualquer consulta devemos criar um objeto `SOAPClient`.
 
     # Realizamos a consulta di servico
     endereco = cliente.nomeservico(..)
+```
 
-As constantes `HOMOG_USUARIO`, `HOMOG_SENHA`, `HOMOLOGACAO` são constantes fornecidas para auxiliar o desenvolvedor
-durante o processo de desenvolvimento. 
+As constantes `HOMOG_USUARIO`, `HOMOG_SENHA`, `HOMOLOGACAO` são constantes fornecidas para auxiliar o desenvolvedor durante o processo de desenvolvimento. 
 
 No momento, a `pysigep` possui as seguintes constantes:
 
@@ -53,7 +97,7 @@ No momento, a `pysigep` possui as seguintes constantes:
 
 Estas constantes podem ser acessadas através do pacote `utils`:
 
-.. code-block:: python
+```python
 
     from pysigep.utils import (URLS,
                                HOMOLOGACAO,
@@ -63,12 +107,13 @@ Estas constantes podem ser acessadas através do pacote `utils`:
                                HOMOG_CODIGO_ADMIN,
                                HOMOG_CARTAO,
                                HOMOG_CNPJ)
+```
+
+#### consultaCEP
 
-consultaCEP
------------
 Este método retorna o endereço correspondente ao número de CEP informado.
 
-.. code-block:: python
+```python
 
     # Criamos o cliente SOAP
     cliente = SOAPClient(ambiente=HOMOLOGACAO,
@@ -87,13 +132,13 @@ Este método retorna o endereço correspondente ao número de CEP informado.
     print(endereco.id)
     print(endereco.uf)
     print(endereco.unidadesPostagem)
+```
 
-verificaDisponibilidadeServico
-------------------------------
+#### verificaDisponibilidadeServico
 
 Verifica se um serviço que não possui abrangência nacional está disponível entre um CEP de Origem e de Destino.
 
-.. code-block:: python
+```python
 
     params = {
         'cod_administrativo': HOMOG_CODIGO_ADMIN,
@@ -112,15 +157,15 @@ Verifica se um serviço que não possui abrangência nacional está disponível
 
     print(disponibilidade)
     # Saída: True ou False
+```
 
-getStatusCartaoPostagem
------------------------
+#### getStatusCartaoPostagem
 
 Este método retorna o situação do cartão de postagem, ou seja, se o mesmo está 'Normal' ou 'Cancelado'. 
 É recomendada a pesquisa periódica para evitar tentativa de postagens com cartão suspenso, ocasionando
 a não aceitação dos objetos nos Correios.
 
-.. code-block:: python
+```python
 
     # Criamos o cliente SOAP
     cliente = SOAPClient(ambiente=HOMOLOGACAO,
@@ -136,13 +181,13 @@ a não aceitação dos objetos nos Correios.
 
     print(status)
     # Saída: 'Normal' ou 'Cancelado'
+```
 
-solicitaEtiquetas
------------------
+#### solicitaEtiquetas
 
 Retorna uma dada quantidade de etiquetas sem o digito verificador.
 
-.. code-block:: python
+```python
 
     params = {
         'tipo_destinatario': 'C',
@@ -169,13 +214,12 @@ Retorna uma dada quantidade de etiquetas sem o digito verificador.
     #             'DL76023728 BR',
     #        ]
 
-
-geraDigitoVerificadorEtiquetas
-------------------------------
+```
+#### geraDigitoVerificadorEtiquetas
 
 Este método retorna o DV - Dígito Verificador de um lista de etiquetas.
 
-.. code-block:: python
+```python
 
     params = {
             'etiquetas': ['DL76023727 BR', 'DL76023728 BR'],
@@ -190,4 +234,6 @@ Este método retorna o DV - Dígito Verificador de um lista de etiquetas.
     lista_digitos = cliente.gera_digito_verificador_etiquetas(**params)
 
     print(lista_digitos)
-    # Saída: lista_digitos = [2, 6]
+    # Saída: lista_digitos = [2, 6]
+```
+

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day