Skip to main content

Python library for processing data from CVM

Project description

About

cvm is a Python library whose job is to extract data from publicly-held companies provided by CVM, thus allowing its use in automated systems. The library was designed to be part of a software for analysis of public companies, although it may be used on its own for other purposes.

What is the CVM?

CVM is the acronym for "Comissão de Valores Mobiliários" ("Securities and Exchange Commission"), which is the government agency that defines the rules for publicly-held companies. In addition to regulating such companies, CVM also makes their data available for public access.

CVM Documents

The CVM's Data Portal provides the following types of documents from publicly-held companies:

  • Registration Form ("Formulário Cadastral" or "FCA")
  • Standardized Financial Statements ("Demonstrações Financeiras Padronizadas" or "DFP")
  • Quarterly Information ("Informações Trimestrais" or "ITR")
  • Reference Form ("Formulário de Referência" or "FRE")
  • Eventual and Periodical Reports ("Informes Periódicos e Eventuais" or "IPE")
  • Registration Information ("Informação Cadastral" or "CAD")

Currently, this library supports the documents FCA, FRE (partial), DFP, and ITR.

Usage

import cvm

with cvm.FCAFile('path/to/fca.zip') as file:
    for fca in file:
        print(fca.company_name, 'sent an FCA document on', fca.receipt_date)

with cvm.DFPITRFile('path/to/dfp_or_itr.zip') as file:
    for dfpitr in file:
        print(dfpitr.company_name, 'sent a', dfpitr.type.name, 'document on', dfpitr.receipt_date)

Note that this library has not been thoroughly tested and its API is still unstable.

More elaborated examples are in the directory samples:

> python -m samples.dfp.print_accounts 'path/to/dfp_or_itr.zip'
> python -m samples.dfp.print_balances 'path/to/dfp_or_itr.zip'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycvm-0.4.1.tar.gz (82.4 kB view hashes)

Uploaded Source

Built Distribution

pycvm-0.4.1-py3-none-any.whl (79.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page