diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index d46cfd2..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/pysigep.rst -/pysigep.*.rst -/modules.rst diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index dbf6960..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pysigep.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pysigep.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/pysigep" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pysigep" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/usage.rst b/docs/README.md similarity index 66% rename from docs/usage.rst rename to docs/README.md index c8d8ea9..296757c 100644 --- a/docs/usage.rst +++ b/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 +

+
+ + +
+ PySIGEP +
+

+ +

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

+ +

+ Sobre | + Recursos | + Instalação | + Utilizaçã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. + +## 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] \ No newline at end of file + # Saída: lista_digitos = [2, 6] +``` + diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..b849713 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-leap-day \ No newline at end of file diff --git a/docs/_static/logo.ico b/docs/_static/logo.ico deleted file mode 100644 index bf5fcf2..0000000 Binary files a/docs/_static/logo.ico and /dev/null differ diff --git a/docs/_static/logo.jpg b/docs/_static/logo.jpg deleted file mode 100644 index 0e9ec01..0000000 Binary files a/docs/_static/logo.jpg and /dev/null differ diff --git a/docs/authors.rst b/docs/authors.rst deleted file mode 100644 index 97979b9..0000000 --- a/docs/authors.rst +++ /dev/null @@ -1,20 +0,0 @@ -======== -Créditos -======== - -Desenvolvedor -------------- - -PySIGEP foi desenvolvido originalmente por: - -* Michell Stuttgart (https://github.com/mstuttgart) - -Contribuidores --------------- - -Agradecimentos aos seguintes contribuidores pelo esforço de fazer a PySIGEP -melhor: - -* [Alessandro Martini](https://github.com/martini97) -* [Danimar Ribeiro](https://github.com/danimaribeiro) -* [Michel Sabchuk](https://github.com/michelts) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100755 index d354d74..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,296 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -# -# pysigep documentation build configuration file, created by -# sphinx-quickstart on Tue Jul 9 22:26:36 2013. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another -# directory, add these directories to sys.path here. If the directory is -# relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# Get the project root dir, which is the parent dir of this -cwd = os.getcwd() -project_root = os.path.dirname(cwd) - -# Insert the project root dir as the first element in the PYTHONPATH. -# This lets us ensure that the source package is imported, and that its -# version is used. -sys.path.insert(0, project_root) - -import pysigep - -# -- General configuration --------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'PySIGEP' -copyright = '""' - -# The version info for the project you're documenting, acts as replacement -# for |version| and |release|, also used in various other places throughout -# the built documents. -# -# The short X.Y version. -version = pysigep.__version__ -# The full version, including alpha/beta/rc tags. -release = pysigep.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -language = 'pt_BR' - -# There are two options for replacing |today|: either, you set today to -# some non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built -# documents. -# keep_warnings = False - - -# -- Options for HTML output ------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a -# theme further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - 'logo': 'logo.jpg', - 'logo_text_align': 'center', - 'github_user': 'mstuttgart', - 'github_repo': 'pysigep', - 'github_button': True, - 'github_type': 'star', - 'github_banner': True, - 'travis_button': True, - 'sidebar_collapse': True, - 'logo_name': True, - 'description': 'Interface para os serviços do SIGEPWeb dos Correios', - 'sidebar_includehidden': True, -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as -# html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the -# top of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon -# of the docs. This file should be a Windows icon file (.ico) being -# 16x16 or 32x32 pixels large. -html_favicon = '_static/logo.ico' - -# Add any paths that contain custom static files (such as style sheets) -# here, relative to this directory. They are copied after the builtin -# static files, so a file named "default.css" will overwrite the builtin -# "default.css". -html_static_path = ['_static'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -html_sidebars = { - '**': [ - 'about.html', - 'navigation.html', - 'relations.html', - 'searchbox.html', - 'donate.html', - ] -} - -# Additional templates that should be rendered to pages, maps page names -# to template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. -# Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. -# Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages -# will contain a tag referring to it. The value of this option -# must be the base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'pysigepdoc' - - -# -- Options for LaTeX output ------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - #'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', 'pysigep.tex', - u'PySIGEP Documentation', - u'Michell Stuttgart', 'manual'), -] - -# The name of an image file (relative to this directory) to place at -# the top of the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings -# are parts, not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output ------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'pysigep', - u'PySIGEP Documentation', - [u'Michell Stuttgart'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ---------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'pysigep', - u'PySIGEP Documentation', - u'Michell Stuttgart', - 'pysigep', - 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index a16e7c0..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,98 +0,0 @@ -.. highlight:: shell - -============ -Contribuindo -============ - -Contribuições são bem-vindas e muito apreciadas! - -Você pode contribuir de várias maneiras: - -Tipos de Contribuições ----------------------- - -Reportando erros -~~~~~~~~~~~~~~~~ - -Informe erros em https://github.com/mstuttgart/pysigep/issues. - -Se você está reportando um *bug*, por favor inclua: - -* O nome e a versão do seu sistema operacional. -* Qualquer detalhe sobre sua configuração local que possa ser útil na solução de problemas. -* Etapas detalhadas para reproduzir o bug. - -Corrigindo erros -~~~~~~~~~~~~~~~~ - -Busque na lista de *issues* por aquelas com a tag *Bug*. -Qualquer *issue* marcada com "Bug" está aberta para quem quiser corrigi-la. - -Adicionando novos recursos -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Busque na lista de *issues* por aquelas com a tag *Improvement* ou *New feature*. -Qualquer *issue* marcada com esses *tags* está aberta para quem quiser implementá-la. - -Melhorando a documentação -~~~~~~~~~~~~~~~~~~~~~~~~~ - -A documentação da PySIGEP sempre pode ser melhorada, seja como parte do -da documentação oficial do PySIGEP, em docstrings, ou mesmo na web em postagens de blog, -artigos e etc. Então caso você tenha escrito alguma postagem sobre a PySIGEP, por favor, -me avise para que a mesma seja incluída aqui como referência. - -Enviar Comentários -~~~~~~~~~~~~~~~~~~ - -A melhor maneira de enviar comentários é abrir uma *issue* em https://github.com/mstuttgart/pysigep/issues. - -Se você está propondo um novo recurso para PySIGEP, por favor siga os seguintes passos: - -* Explique em detalhes como isso funcionaria. -* Mantenha o escopo o mais simples possível, para facilitar a implementação. -* Lembre-se que este é um projeto voluntário, e que contribuições são bem-vindos :) - -Começando a contribuir! ------------------------ - -Pronto para contribuir? Veja como configurar `pysigep` para desenvolvimento local. - -1. Fork o repositório `pysigep` no GitHub. -2. Clone sua *branch* localmente:: - - $ git clone git@github.com:your_name_here/pysigep.git - -3. Instale sua cópia local em um *virtualenv*. Supondo que você tenha instalado o *virtualenv*, é assim que você configura a seu *fork* para o desenvolvimento local:: - - $ cd pysigep - $ virtualenv -p python3 env - $ pip3 install -r requirements.txt - -4. Crie uma *branch* para desenvolvimento:: - - $ git checkout -b nome-da-sua-branch - -   Agora você pode fazer suas mudanças localmente. - -5. Quando terminar de fazer alterações, verifique se suas alterações passam no *flake8* e nos testes:: - - $ flake8 pysigep tests - $ python setup.py test - -6. Confirme as suas alterações e as envie para o GitHub:: - - $ git add . - $ git commit -m "Descricao detalhada das sua alteracoes." - $ git push origin nome-da-sua-branch - -7. Envie um *Pull Request* para o repositório oficial da PySIGEP no GitHub. - -Instruções de Solicitação de Pull Request ------------------------------------------ - -Antes de enviar um pedido de *Pull Request*, verifique se ele atende a essas diretrizes: - -1. O pedido de *Pull Request* deve incluir testes, quando for uma nova *feature*. -2. Se o *Pull Request* adicionar funcionalidades, a documentação deve ser atualizada adicionado detalhes de uso da nova funcionalidade. -3. O pedido de *Pull Request* deve funcionar para o Python 3.5+. Verificar https://travis-ci.org/mstuttgart/pysigep/pull_requests e certifique-se de que os testes passem para todas as versões do Python suportadas. \ No newline at end of file diff --git a/docs/history.rst b/docs/history.rst deleted file mode 100644 index 11ebb4b..0000000 --- a/docs/history.rst +++ /dev/null @@ -1,8 +0,0 @@ -========= -Historico -========= - -0.0.1 (2018-05-06) ------------------- - -* Versão inicial de desenvolvimento. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 1c88c89..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -Bem vindo a PySIGEP! -==================== - -Interface python para uso dos serviços fornecidos pelo SIGEPWeb dos Correios. - -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. - -.. toctree:: - :maxdepth: 2 - :hidden: - :glob: - - installation - usage - contributing - authors - history - modules - -Encontrou algum erro? Tem alguma sugestão para melhorar a PySIGEP? Deixe-me saber. -Contribuições são muito bem vindas! \ No newline at end of file diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 02c142f..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. highlight:: shell - -========== -Instalação -========== - -Atualmente, a PySIGEP possui suporte para Python 3.5+. - -Versão estável --------------- - -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. - -Para instalar PySIGEP, execute este comando no seu terminal: - -.. code-block:: console - - $ pip install pysigep - -Este é o método recomendado para instalar a PySIGEP. Desse modo sempre será instalado a versão mais recente. - -A partir do código fonte ------------------------- - -O código fonte do PySIGEP pode ser baixado `aqui`_. - -Você pode realizar o *clone* do repositório público: - -.. code-block:: console - - $ git clone https://github.com/mstuttgart/pysigep.git - -Ou baixar o `tarball`_: - -.. code-block:: console - - $ curl -OL https://github.com/mstuttgart/pysigep/tarball/master - -Uma vez que você tenha uma cópia do código fonte, você pode instalá-lo com: - -.. code-block:: console - - $ python setup.py install - - -.. _aqui: https://github.com/mstuttgart/pysigep -.. _tarball: https://github.com/mstuttgart/pysigep/tarball/master \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index ceecb8c..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,242 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pysigep.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pysigep.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -:end