Updated documentation

Author: wilsonfreitas

docs/_static/images/savefig/currency1.png

@@ -12,14 +12,15 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'python-bcb'
-copyright = '2021, Wilson Freitas'
-author = 'Wilson Freitas'
+project = "python-bcb"
+copyright = "2021, Wilson Freitas"
+author = "Wilson Freitas"
 
 # The full version, including alpha/beta/rc tags
 # release = '0.1.7'
@@ -31,38 +32,35 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autosectionlabel',
-    'IPython.sphinxext.ipython_directive',
-    'IPython.sphinxext.ipython_console_highlighting',
-    'matplotlib.sphinxext.plot_directive',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosectionlabel",
+    "IPython.sphinxext.ipython_directive",
+    "IPython.sphinxext.ipython_console_highlighting",
+    "matplotlib.sphinxext.plot_directive",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = 'pt_br'
+language = "pt_br"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- 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 = 'pydata_sphinx_theme'
+html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     "external_links": [],
     "github_url": "https://github.com/wilsonfreitas/python-bcb",
@@ -71,6 +69,8 @@
 # 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']
+html_static_path = ["_static"]
 
 autosummary_generate = True
+
+ipython_savefig_dir = "_static/images/savefig/"

docs/_static/images/savefig/sgs1.png

@@ -27,10 +27,9 @@ O módulo ``currency`` obtem dados de moedas do conversor de moedas do Banco Cen
 
 .. ipython:: python
 
+    @savefig currency1.png
     df.plot(figsize=(12, 6));
 
-.. plot:: plots/currency1.py
-
 
 .. autofunction:: get_currency_list
 

docs/_static/images/savefig/taxajuros1.png

@@ -6,6 +6,17 @@
 python-bcb 
 ==========
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Conteúdo:
+
+   sgs
+   currency
+   expectativas
+   taxajuros
+   odata
+   api
+
 **python-bcb** é uma interface em Python estruturada para obter informações
 da API de dados abertos do `Banco Central do Brasil <https://www.bcb.gov.br>`_.
 
@@ -76,18 +87,6 @@ Uso
    sgs.get(('IPCA', 433), last=12)
 
 
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Conteúdo:
-
-   sgs
-   currency
-   expectativas
-   odata
-   api
-
-
 Índices e tabelas
 ==================
 

docs/conf.py

@@ -38,6 +38,5 @@ Função :ref:`bcb.sgs.get`
     plt.suptitle('IPCA acumulado 12 meses - Janela Móvel', fontsize=18)
     plt.xlabel('Data')
     plt.ylabel('%')
+    @savefig sgs1.png
     plt.legend().set_visible(False)
-
-.. plot:: plots/sgs1.py

docs/currency.rst

@@ -0,0 +1,55 @@
+Taxas de Juros
+##############
+
+A API de taxas de juros de operações de crédito pode ser acessada através da
+classe :py:class:`bcb.TaxaJuros`.
+
+.. _documentacao: https://olinda.bcb.gov.br/olinda/servico/TaxaJuros/versao/v1/documentacao
+
+__ documentacao_
+
+Os dados são obtidos a partir da `API de Taxas de Juros`__.
+
+.. currentmodule:: bcb
+
+
+.. autoclass:: TaxaJuros
+  :members:
+  :inherited-members:
+
+
+Esta API tem os ``EntitySets``:
+
+.. ipython:: python
+
+    from bcb import TaxaJuros
+    em = TaxaJuros()
+    em.describe()
+
+As características do ``EntitySets`` podem ser visualizadas por:
+
+.. ipython:: python
+
+    em.describe("TaxasJurosDiariaPorInicioPeriodo")
+
+Vejamos um gráfico da mediana das taxas de juros do cheque especial praticada
+pelas instituições financeiras.
+
+.. ipython:: python
+
+    import pandas as pd
+
+    ep = em.get_endpoint('TaxasJurosDiariaPorInicioPeriodo')
+    df_cheque = (ep.query()
+                   .filter(ep.Segmento == 'PESSOA FÍSICA',
+                           ep.Modalidade == 'CHEQUE ESPECIAL - PRÉ-FIXADO')
+                   .collect())
+    df_cheque['InicioPeriodo'] = pd.to_datetime(df_cheque['InicioPeriodo'])
+    grp = df_cheque.groupby('InicioPeriodo')
+    df_mean = grp.agg({'TaxaJurosAoMes': 'median'})
+
+    @savefig taxajuros1.png
+    df_mean['TaxaJurosAoMes'].plot(figsize=(16,6), style='o', markersize=1,
+                                   xlabel='Data', ylabel='Taxa',
+                                   title='Médias das Taxas de Juros de Cheque Especial - Fonte:BCB');
+