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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file pycvm-0.4.1.tar.gz.

File metadata

  • Download URL: pycvm-0.4.1.tar.gz
  • Upload date:
  • Size: 82.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.1

File hashes

Hashes for pycvm-0.4.1.tar.gz
Algorithm Hash digest
SHA256 15f32607748fefce4b4b1a3c11e236128667b0c7f52a45b7a6ed01692b053a13
MD5 dcc6dfc3a3334fe5bb96883ddc42b1c1
BLAKE2b-256 0a1cf3f5dd5e836a79e3b4d67b7aa62169285722cab7ab9020adb7b614f048fe

See more details on using hashes here.

File details

Details for the file pycvm-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: pycvm-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 79.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.1

File hashes

Hashes for pycvm-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dea46439b8ea85a6c4ce57e149e90e8ae939902ecd99a418d67e51ca8450bb4f
MD5 c8eb13d6b73b69d0d76086250d31948f
BLAKE2b-256 81a9c28a035e98266001bab8bb043bdfa3656ecca3bb9c7c5053adfd73564c48

See more details on using hashes here.

Supported by

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