Skip to content

Commit c494ef2

Browse files
committed
deploy: d1f985d
1 parent 4f41011 commit c494ef2

16 files changed

Lines changed: 253 additions & 69 deletions

.doctrees/api.doctree

3.46 KB
Binary file not shown.

.doctrees/currency.doctree

3.89 KB
Binary file not shown.

.doctrees/environment.pickle

28.1 KB
Binary file not shown.

.doctrees/expectativas.doctree

7.23 KB
Binary file not shown.

.doctrees/odata.doctree

9.16 KB
Binary file not shown.

.doctrees/taxajuros.doctree

2.58 KB
Binary file not shown.

_sources/currency.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ __ documentacao_
1717

1818
A classe :py:class:`bcb.PTAX` retorna cotações de moedas obtidas a partir da `API de Moedas`__ do BCB.
1919
Esta implementação é mais estável que a do :ref:`Conversor de Moedas`.
20+
O método ``describe`` mostra os *endpoints*, parâmetros e propriedades disponíveis.
2021

2122
.. ipython:: python
2223

_sources/expectativas.rst.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ defasagem de 1 ano.
2626

2727
Ao instanciar a classe :py:class:`bcb.Expectativas` diversas informações
2828
são obtidas e a melhor maneira de interagir com a API é
29-
através do método :py:meth:`bcb.Expectativas.describe`.
29+
através do método :py:meth:`bcb.Expectativas.describe`, que mostra os
30+
*endpoints* e suas propriedades. Para obter apenas a listagem curta dos nomes,
31+
use ``describe(full=False)``.
3032

3133

3234
.. ipython:: python
@@ -35,10 +37,9 @@ através do método :py:meth:`bcb.Expectativas.describe`.
3537
em = Expectativas()
3638
em.describe()
3739
38-
O método :py:meth:`bcb.Expectativas.describe` também recebe o nomes dos
39-
*endpoints* e apresenta uma descrição do *endpoint* trazendo o seu tipo
40-
`EntityType` e as propriedades retornadas `Properties` e os seus respectivos
41-
tipos.
40+
O método :py:meth:`bcb.Expectativas.describe` também recebe o nome de um
41+
*endpoint* para restringir a saída, apresentando o seu tipo `EntityType` e as
42+
propriedades retornadas `Properties` com os seus respectivos tipos.
4243

4344
.. ipython:: python
4445

_sources/odata.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ Segue um exemplo de como acessar a API do PIX.
5252
pix = SPI()
5353
5454
É necessário importar e criar um objeto da classe que implementa a API, neste caso a classe ``SPI``.
55-
Tendo o objeto, executar o método ``describe`` para visualizar o *endpoints* disponíveis na API.
55+
Tendo o objeto, executar o método ``describe`` para visualizar os *endpoints* disponíveis na API e suas propriedades. Para obter apenas a listagem curta dos nomes, use ``describe(full=False)``.
5656

5757

5858
.. ipython:: python
5959
6060
pix.describe()
6161
6262
Como vemos, a API do PIX tem 4 *endpoints* (``EntitySets``).
63-
Para ver as informações retornadas por cada *endpoint* é só executar o método ``describe`` passando como argumento
63+
Para restringir a saída a um *endpoint*, execute o método ``describe`` passando como argumento
6464
o nome do *endpoint*.
6565

6666
.. ipython:: python

_sources/taxajuros.rst.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,16 @@ __ documentacao_
1111
Os dados são obtidos a partir da `API de Taxas de Juros`__.
1212

1313

14-
Esta API usa o serviço ``taxaJuros`` versão ``v2`` e tem os ``EntitySets``:
14+
Esta API usa o serviço ``taxaJuros`` versão ``v2``. O método ``describe``
15+
mostra os ``EntitySets`` e suas propriedades:
1516

1617
.. ipython:: python
1718
1819
from bcb import TaxaJuros
1920
em = TaxaJuros()
2021
em.describe()
2122
22-
As características do ``EntitySets`` podem ser visualizadas por:
23+
Para restringir a saída a um ``EntitySet`` específico, informe o seu nome:
2324

2425
.. ipython:: python
2526

0 commit comments

Comments
 (0)