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.
- Gerar e publicar a documentação: geração, visualização local e GitHub Pages.
- 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, com métodos linear e flat_forward |
interpolar, interpolar_expr |
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, leiloes_bcb, benchmarks, dealers, 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, 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, duration_expr, dv01, dv01_expr, implicitas |
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, cotacao_curva_zero, taxa_curva_zero, pu, taxa, duration, duration_expr, dv01, dv01_expr |
yd.ntnf |
módulo | NTN-F | dados, vencimentos, datas_pagamento, fluxos_caixa, pu, taxa, taxas_zero, taxas_zero_forwards, 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, ultimo, projetado, vigencia, contexto, calcular_vna, calcular_base |
yd.copom |
módulo | Calendário automático do Copom | calendario, proxima_reuniao |
yd.compromissadas(inicio, fim) |
função | Leilões de operações compromissadas do BCB | |
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 | contratos, probabilidades |
yd.ipca |
módulo | IPCA histórico e projetado | indice, indice_serie, taxa, taxa_serie, taxa_projetada, calendario |
yd.igpm |
módulo | Taxas e números-índice do IGP-M | taxa, taxa_serie, indice, indice_serie, calendario |
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.
Novidades na versão 0.60.0
Esta seção cobre apenas as mudanças da 0.59.0 para a 0.60.0. Consulte também as
notas de migração.
Contratos com Decimal
Os históricos e cálculos de VNA e os indicadores de inflação passam a preservar
precisão decimal. Revise operações que misturam esses retornos com float:
use Decimal("0.0045") para constantes exatas e .is_nan() para verificar
um retorno escalar Decimal("NaN"). Converta para float explicitamente
apenas quando a aplicação aceitar perder essa precisão.
| Operação | Retorno na 0.60.0 |
|---|---|
vna.valor, vna.projetado, vna.calcular_vna, vna.calcular_base |
Decimal |
Coluna vna de vna.historico e vna.ultimo |
Decimal(18, 6) |
ipca.indice / coluna indice de ipca.indice_serie |
Decimal / Decimal(18, 2) |
ipca.taxa / coluna taxa de ipca.taxa_serie |
Decimal / Decimal(18, 4) |
ipca.taxa_projetada().valor_projetado |
Decimal com quatro casas |
igpm.taxa / coluna taxa de igpm.taxa_serie |
Decimal / Decimal(18, 4) |
igpm.indice / coluna indice de igpm.indice_serie |
Decimal / Decimal(18, 10) |
vna.calcular_vna também passa de float("nan") para Decimal("NaN")
na ausência de dados. Os cálculos de VNA usam 28 dígitos de precisão e aplicam
os truncamentos e arredondamentos da metodologia; resultados intermediários
podem diferir dos obtidos anteriormente com float.
Séries do IPCA
As consultas históricas do IPCA seguem o padrão das séries de Selic e PTAX:
taxa(data) e indice(data) retornam um valor; taxa_serie e indice_serie
retornam séries por intervalo ou pelos últimos meses.
Para migrar, substitua ipca.taxas(inicio, fim) por
ipca.taxa_serie(inicio, fim) e ipca.indices(inicio, fim) por
ipca.indice_serie(inicio, fim). Substitua ipca.taxas_ultimas(n) por
ipca.taxa_serie(ultimos=n) e ipca.indices_ultimos(n) por
ipca.indice_serie(ultimos=n). Os nomes antigos foram removidos. As colunas e unidades são preservadas;
os tipos numéricos mudam conforme descrito acima.
O número-índice agora usa Decimal: ipca.indice(data) retorna Decimal
(ou Decimal("NaN") quando indisponível), e a coluna indice de
ipca.indice_serie(...) usa Decimal(18, 2). A conversão parte do texto do
IBGE, sem passar por float.
As taxas também usam Decimal: ipca.taxa(data) retorna Decimal (ou
Decimal("NaN")), e a coluna taxa de ipca.taxa_serie(...) usa
Decimal(18, 4). O campo valor_projetado de ipca.taxa_projetada() passa a
ser Decimal com quatro casas. A unidade permanece decimal: 0,45% corresponde
a Decimal("0.0045").
Nas séries, fim=None usa a data atual no Brasil. Informe inicio ou
ultimos; quando informado, ultimos tem prioridade sobre as datas.
Contexto de VNA e calendários de inflação
yd.vna.contexto(...)reúne os parâmetros da vigência de NTN-B ou NTN-C: VNAs publicados, competência, inflação e pendências. Exigevencimentopara NTN-C e aceita uma projeção explícita quando a inflação realizada não existe. As entradas de inflação emcontextoeprojetadoaceitam números decimais (0.0045) ou percentuais explícitos ("0.45%"ou"0,45%"). A colunainflacaodecontextousa Decimal e pode ser passada diretamente aprojetado. Migração: substitua o antigoinflacao=0.45porinflacao="0.45%"ouinflacao=0.0045; números puros agora representam taxas decimais.yd.ipca.calendario(ano, atualizar=False)consulta as datas previstas de divulgação no IBGE pelo ano da competência, incluindo dezembro divulgado no ano seguinte.yd.igpm.calendario(ano, atualizar=False)consulta as divulgações mensais na FGV IBRE, excluindo prévias decendiais. Os calendários não comprovam que os índices já foram publicados.
Outras mudanças
yd.vna.calcular_base(titulo, indice_atual, vencimento=None)calcula a base mensal da NTN-B ou NTN-C com o número-índice realizado do IPCA ou IGP-M, ou o VNA da LFT com o fator Selic acumulado desde 01/07/2000, sem acesso à rede. As origens e os índices iniciais são constantes internas; NTN-C exige vencimento para selecionar a série e seu ajuste de emissão. Para LFT, arredonda o fator em dezesseis casas; para NTN-B e NTN-C, trunca o fator nessa precisão. Trunca o VNA em seis casas, preservando a precisão da origem e evitando encadear VNAs mensais já truncados.- Novo módulo
yd.igpm, comtaxaetaxa_seriepara consultar taxas mensais do IGP-M via SGS/BCB.taxaretornaDecimal(ouDecimal("NaN")quando indisponível), e a colunataxadetaxa_serieusaDecimal(18, 4). A unidade é decimal: 0,27% corresponde aDecimal("0.0027").indiceeindice_seriefornecem os números-índice da FGV via Ipeadata (sérieIGP12_IGPM12), comoDecimale colunaDecimal(18, 10). As dez casas preservam o histórico anterior a 1994. As séries aceitam intervalo ouultimos, com competênciaperiodono formatoYYYYMM. - No CPM, substitua
yd.cpm.data(data)poryd.cpm.contratos(data)e useyd.cpm.probabilidades(data, tipo_opcao="call")para as probabilidades. Esta última retorna todas as reuniões disponíveis; filtre o DataFrame para selecionar uma reunião. - Leilões do BCB passam de
yd.bc.leiloesparayd.tpf.leiloes_bcb, com nomes de colunas alinhados aos deyd.tpf.leiloes. - No mercado secundário,
yd.tpf.secundario.ler(fonte)substituiler_zipezip_para_silver: aceita caminho ou bytes de ZIP e incluifinanceirona saída.nome_arquivo_mensaldeixa de ser público. yd.ntnf.premiofoi removida. Useyd.tpf.premios_pre(data)e filtretitulo == "NTN-F"para obter o prêmio bruto.yd.tpf.taxase as consultasdadosde LFT, LTN, NTN-B, NTN-C e NTN-F preservam colunas e tipos quando não há dados. Nos leilões do Tesouro, PU mínimo informado como zero passa a ser nulo, e o financeiro ofertado usa o PU médio calculado quando necessário.yd.rmdpassa a propagar erros de download e processamento, em vez de retornar um DataFrame vazio nessas situações.
Consulte as releases do GitHub para o histórico completo e as notas de migração de versões anteriores.
Projeto
1 maintainer
Metadata
1 maintainer
Release files for pyield 0.60.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pyield-0.60.0.tar.gz | 161.4 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyield-0.60.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 372.2 kB
Release files / pyield-0.60.0.tar.gz
| Download URL | pyield-0.60.0.tar.gz |
|---|---|
| Size | 161.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dfb72df0668bce26c8e21fa69106ab4d7fa0d939cbefec20264593f64e348504
|
|
BLAKE2b-256 checksum How to use checksums |
c576f2a924cbb6a1793f27d59be113907ac06d56b4b6acd5805c17ca99acfa8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Bluefin","version":"44","id":"Deinonychus","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pyield-0.60.0-py3-none-any.whl
| Download URL | pyield-0.60.0-py3-none-any.whl |
|---|---|
| Size | 210.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e0d99c61b06ca000f197e4b779e1336236f41c5c7eb14ce98a59b2018ee1ebdb
|
|
BLAKE2b-256 checksum How to use checksums |
3deeabdde6ad8031d91527d36be1586d03fcaa9d03977e73cc7cc50e6f8ccc48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Bluefin","version":"44","id":"Deinonychus","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for pyield 0.60.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
