deploy: 9d11af1

Author: wilsonfreitas

_images/currency1.png

@@ -5,36 +5,19 @@ API
 Módulo :py:mod:`bcb.sgs`
 ------------------------
 
-.. currentmodule:: bcb.sgs
-
-.. autosummary::
-
-   get
+.. automodule:: bcb.sgs
+   :members:
 
 Módulo :py:mod:`bcb.currency`
 -----------------------------
 
-.. currentmodule:: bcb.currency
-
-.. autosummary::
-
-   get
-   get_currency_list
-
+.. automodule:: bcb.currency
+   :members:
 
 :ref:`APIs OData`
 -----------------
 
-.. currentmodule:: bcb
-
-.. autosummary::
-
-   Endpoint
-   BaseODataAPI
-   ODataAPI
-   Expectativas
-   PTAX
-   IFDATA
-   TaxaJuros
-   SPI
-   MercadoImobiliario
+.. automodule:: bcb
+   :members:
+   :member-order: bysource
+   :special-members: __init__

_images/sgs1.png

@@ -4,41 +4,8 @@ Moedas
 O pacote tem 2 APIs que dão acesso a informações de moedas.
 
 
-- Webscraping no :ref:`Conversor de Moedas`
 - :ref:`API OData` com cotações de taxas de câmbio
-
-
-Conversor de Moedas
--------------------
-
-.. automodule:: bcb.currency
-
-O módulo :py:mod:`bcb.currency` obtem dados de moedas do conversor de moedas do Banco Central através de webscraping.
-
-.. currentmodule:: bcb.currency
-
-.. autofunction:: get
-
-
-.. ipython:: python
-
-    from bcb import currency
-    df = currency.get(['USD', 'EUR'],
-                      start='2000-01-01',
-                      end='2021-01-01',
-                      side='ask')
-    df.head()
-
-    @savefig currency1.png
-    df.plot(figsize=(12, 6));
-
-
-.. autofunction:: get_currency_list
-
-
-.. ipython:: python
-
-    currency.get_currency_list().head()
+- Webscraping no :ref:`Conversor de Moedas`
 
 API OData
 ---------
@@ -48,13 +15,8 @@ API OData
 
 __ documentacao_
 
-Diferente do módulo :py:mod:`bcb.currency`, aqui os dados são obtidos a partir da `API de Moedas`__.
-
-.. currentmodule:: bcb
-
-
-.. autoclass:: PTAX
-
+A classe :py:class:`bcb.PTAX` retorna cotações de moedas os obtidas a partir da `API de Moedas`__ do BCB.
+Esta implementação é mais estável que a do :ref:`Conversor de Moedas`.
 
 .. ipython:: python
 
@@ -92,3 +54,26 @@ são preenchidos com 0 para ter 2 dígitos.
                    dataInicial='1/1/2022',
                    dataFinalCotacao='1/5/2022')
        .collect())
+
+Conversor de Moedas
+-------------------
+
+O módulo :py:mod:`bcb.currency` obtem dados de moedas do conversor de moedas do Banco Central através de webscraping.
+
+.. ipython:: python
+
+    from bcb import currency
+    df = currency.get(['USD', 'EUR'],
+                      start='2000-01-01',
+                      end='2021-01-01',
+                      side='ask')
+    df.head()
+
+    @savefig currency1.png
+    df.plot(figsize=(12, 6));
+
+
+.. ipython:: python
+
+    currency.get_currency_list().head()
+

_images/taxajuros1.png

@@ -28,13 +28,6 @@ Ao instanciar a classe :py:class:`bcb.Expectativas` diversas informações
 são obtidas e a melhor maneira de interagir com a API é
 através do método :py:meth:`bcb.Expectativas.describe`.
 
-.. currentmodule:: bcb
-
-
-.. autoclass:: Expectativas
-  :members:
-  :inherited-members:
-
 
 .. ipython:: python
 

_sources/api.rst.txt

@@ -47,24 +47,44 @@ APIs implementadas
    indicadores econômicos, ..., e com um simples chamado da função
    :py:func:`bcb.sgs.get` é possível tê-las
    em um ``DataFrame`` pandas.
+   Veja a documentação em :ref:`SGS`.
 ``Conversor de Moedas``
    Implementado no módulo ``currency``, um conjunto de funções que realiza webscraping
-   no site do `Conversos de Moedas <https://www.bcb.gov.br/conversao>`_
+   no site do `Conversor de Moedas <https://www.bcb.gov.br/conversao>`_
    do Banco Central, possível obter séries temporais de frequência diária
    de diversas moedas.
+   Veja a documentação em :ref:`Conversor de Moedas`.
 ``Moedas OData``
    O Banco Central disponibiliza diversas informações em APIs que
    seguem o padrão `OData <https://odata.org>`.
    A classe :py:class:`bcb.PTAX` implementa uma API OData que
    entrega os boletins diários de taxas de câmbio do Banco Central.
    Esta API entrega mais informações do que o que é obtido no
    ``Conversor de Moedas``.
+   Veja a documentação em :ref:`API de Moedas`.
 ``Expectativas``
    A API de Expectativas de Mercado traz todas as estatísticas das variáveis
    macroeconômicas fornecidos por um conjuto de instituições do mercado
    financeiro.
    A classe :py:class:`bcb.Expectativas` implementa essa interface no
    padrão OData.
+   Veja a documentação em :ref:`API de Expectativas`.
+``Taxas de Juros``
+   API que retorna as taxas de juros de operações de crédito por instituição financeira (médias dos últimos 5 dias).
+   A classe :py:class:`bcb.TaxaJuros` implementa essa interface.
+   Veja a documentação em :ref:`Taxas de Juros`.
+``ODataAPI``
+   O BCB disponibiliza diversas APIs que seguem a especificação OData.
+   Algumas APIs mais utilizadas como as :py:class:`bcb.PTAX` e
+   :py:class:`bcb.Expectativas` possuem uma classe específica, para as
+   APIs menos utilizadas, é possível utilizar a classe :py:class:`bcb.ODataAPI`
+   para acessar a API.
+   Toda API que segue a especificação OData possui uma URL de acesso, esta URL
+   é passada para a classe :py:class:`bcb.ODataAPI` e o objeto criado dá
+   total acesso a API.
+   Veja a documentação em :ref:`Classe ODataAPI`.
+Muito mais
+   Veja todos os *endpoints* implementados na documentação de nossa :ref:`API`.
 
 
 Uso

_sources/currency.rst.txt

@@ -50,8 +50,8 @@ que possui os seguintes métodos.
 Aplicações
 ----------
 
-Expectativas
-^^^^^^^^^^^^
+API de Expectativas
+^^^^^^^^^^^^^^^^^^^
 
 Vamos ver como isso tudo funciona utilizando a API de expectativas.
 
@@ -152,8 +152,8 @@ um conjunto de colunas.
      .limit(10)
      .collect())
 
-Moedas
-^^^^^^
+API de Moedas
+^^^^^^^^^^^^^
 
 Uma outra aplicação é com a API de Moedas que implementa a especificação OData.
 Utilizando a classe :py:class:`bcb.PTAX` temos:
@@ -207,11 +207,6 @@ Podemos filtrar apenas pelos dados de abertura.
 Classe ODataAPI
 ^^^^^^^^^^^^^^^
 
-.. currentmodule:: bcb
-
-.. autoclass:: ODataAPI
-    :inherited-members:
-
 O portal de Dados Abertos to Banco Central apresenta diversas APIs OData, são
 dezenas de APIs disponíveis.
 A URL com metadados de cada API pode ser obtida no portal.

_sources/expectativas.rst.txt

@@ -1,19 +1,10 @@
 SGS
 ===
 
-O módulo ``sgs`` obtem os dados do webservice do Banco Central,
+A função :py:func:`bcb.sgs.get` obtem os dados do webservice do Banco Central ,
 interface json do serviço BCData/SGS - 
 `Sistema Gerenciador de Séries Temporais (SGS) <https://www3.bcb.gov.br/sgspub/localizarseries/localizarSeries.do?method=prepararTelaLocalizarSeries>`_.
 
-.. automodule:: bcb.sgs
-
-Função bcb.sgs.get
---------------------
-
-.. currentmodule:: bcb.sgs
-
-.. autofunction:: get
-
 Exemplo
 -------
 

_sources/index.rst.txt

@@ -10,13 +10,6 @@ __ 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``:
 
@@ -44,12 +37,11 @@ pelas instituições financeiras.
                    .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');
+                                   title='Mediana das Taxas de Juros de Cheque Especial - Fonte:BCB');