PYield: Toolkit de Renda Fixa Brasileira
Português | English
PYield é uma biblioteca Python voltada para análise de títulos públicos
brasileiros. Ela busca e processa dados da ANBIMA, BCB, IBGE, B3 e Tesouro
Nacional, retornando tipos nativos do Python, polars.Series ou
polars.DataFrame, conforme a operação.
Embora inclua dados e ferramentas de outros mercados, como DI1, DAP e PTAX, esses recursos apoiam o objetivo central da biblioteca: análise, precificação e acompanhamento de títulos públicos brasileiros.
Instalação
Com pip:
pip install pyield
Em um projeto gerenciado pelo uv:
uv add pyield
Próximos passos
- Quickstart: primeiros usos da biblioteca.
- Documentação completa: conceitos e referência por módulo.
- Mapa da API: namespaces e funções públicas.
- Desenvolvimento e publicação: ambiente, verificações, build e PyPI.
- Notebook no Colab: exploração interativa.
- Pacote no PyPI.
Mapa da API
| Componente | Tipo | Finalidade | Funções públicas |
|---|---|---|---|
yd.du |
módulo | Dias úteis e calendário brasileiro | contar, deslocar, eh_dia_util, gerar, ultimo_dia_util, contar_expr, deslocar_expr, eh_dia_util_expr |
yd.Interpolador |
classe | Interpolação escalar e em pipelines Polars | interpolar, interpolar_expr, linear, flat_forward |
yd.interpolar(...) |
função | Interpolação vetorizada flat-forward, curva única ou multi-curva | |
yd.forward(...) |
função | Taxa a termo entre dois vértices | |
yd.forwards(...) |
função | Curva de taxas a termo | |
yd.futuro |
módulo | Contratos futuros da B3 | di1, historico, intradia, datas_disponiveis, vencimento, enriquecer, vencimento_expr |
yd.di1 |
módulo | Curva DI1 e interpolação | dados, interpolar_taxas, interpolar_taxa, datas_disponiveis |
yd.tpf |
módulo | Títulos públicos federais | taxas, taxas_historicas, vencimentos, estoque, leiloes, benchmarks, curva_pre, premios_pre, secundario |
yd.rmd(aba) |
função | Relatório Mensal da Dívida do Tesouro Nacional | |
yd.lft |
módulo | LFT | dados, vencimentos, cotacao, pu, taxa, vna, rentabilidade, rentabilidade_expr |
yd.ltn |
módulo | LTN | dados, vencimentos, pu, taxa, duration_expr, dv01, dv01_expr, rentabilidade, rentabilidade_expr, taxas_forward |
yd.ntnb |
módulo | NTN-B | dados, vencimentos, datas_pagamento, fluxos_caixa, cotacao, pu, taxa, taxas_zero, duration, dv01, dv01_expr, implicitas, curva |
yd.ntnb1 |
módulo | NTN-B1 (Educa+ e Renda+) | NomeComercial, datas_pagamento, fluxos_caixa, cotacao, cotacao_curva_zero, taxa_curva_zero, pu, duration, dv01 |
yd.ntnbp |
módulo | NTN-B Principal | cotacao, taxa, pu, dv01 |
yd.ntnc |
módulo | NTN-C | dados, datas_pagamento, fluxos_caixa, cotacao, pu, taxa, duration, duration_expr, dv01, dv01_expr |
yd.ntnf |
módulo | NTN-F | dados, vencimentos, datas_pagamento, fluxos_caixa, pu, taxa, taxas_zero, premio, premio_limpo, premio_limpo_expr, rentabilidade, rentabilidade_expr, duration, duration_expr, dv01, dv01_expr |
yd.vna |
módulo | Valores nominais atualizados dos títulos públicos | valor, historico, projetado, vigencia |
yd.copom |
módulo | Calendário automático do Copom | calendario, proxima_reuniao |
yd.compromissadas(...) |
função | Leilões de operações compromissadas do BCB | inicio, fim |
yd.selic |
módulo | Selic e política monetária | over, over_serie, meta, meta_serie |
yd.cpm |
módulo | Opções digitais do COPOM e análises derivadas | data, probabilidades |
yd.ipca |
módulo | IPCA histórico e projetado | indice, indices, indices_ultimos, taxa, taxas, taxas_ultimas, taxa_projetada |
yd.ptax(data) |
função | PTAX para uma data | |
yd.ptax_serie(inicio, fim) |
função | Série histórica da PTAX | |
yd.di_over(data) |
função | Taxa DI Over | |
yd.hoje() |
função | Data atual no Brasil | |
yd.agora() |
função | Data e hora atual no Brasil |
O mapa completo da API inclui a documentação detalhada e as assinaturas públicas.
Compatibilidade da API
Este resumo parte da API da 0.56.0. Mudanças que já faziam parte dessa versão
ou de versões anteriores estão no histórico das
releases do GitHub.
| Antes | Agora |
|---|---|
ntnbp.taxas_zero(...) |
ntnb.taxas_zero(...), sem incluir_vertices |
ntnb.taxas_zero(..., incluir_cupons=...) |
ntnb.taxas_zero(...), sem incluir_cupons |
ntnb.taxas_zero(..., percentual=...) |
ntnb.taxas_zero(...), com taxas em formato decimal |
yd.tpf.ntnb |
yd.ntnb ou from pyield import ntnb |
yd.tpf.rmd(aba) |
yd.rmd(aba) ou from pyield import rmd |
pyield.tpf.vna.calcular_vna(...) |
yd.vna.calcular_vna(...) |
yd.ntnb.vna(data) |
yd.vna.valor("NTN-B", data) |
yd.ntnb.vnas() |
yd.vna.historico("NTN-B") |
vna_projetado(...) nos módulos de títulos |
yd.vna.projetado(titulo, data, vna_base, inflacao) |
vigencia(data) nos módulos de títulos |
yd.vna.vigencia(titulo, data) |
Os módulos públicos de títulos ficam disponíveis na raiz, enquanto as
implementações continuam organizadas internamente em pyield/tpf/titulos/.
Consulte as releases para o
histórico completo.
Projeto
1 maintainer
Metadata
1 maintainer
Release files for pyield 0.57.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyield-0.57.1.tar.gz | 132.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyield-0.57.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 315.0 kB
Release files / pyield-0.57.1.tar.gz
| Download URL | pyield-0.57.1.tar.gz |
|---|---|
| Size | 132.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c3fa2bced080faaf6b0358cb4e8616b3a4d48a2b9ea86ec55220f0f8758f5780
|
|
BLAKE2b-256 checksum How to use checksums |
b73ed58349a22bea2ccd4c1457d3ba7bf6443b4cb5db9b43395fda29565a4131
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pyield-0.57.1-py3-none-any.whl
| Download URL | pyield-0.57.1-py3-none-any.whl |
|---|---|
| Size | 183.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0cec4cea97071167d57f85a91e70ac45eca2036316b41260a8da3f99e16a1d36
|
|
BLAKE2b-256 checksum How to use checksums |
93ef707e2d5f4c1ada20acf1f8a75aadd5169b59db686177ef762d71498a48b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
