pycvm


Namepycvm JSON
Version 0.4.1 PyPI version JSON
download
home_pagehttps://github.com/glourencoffee/pycvm/
SummaryPython library for processing data from CVM
upload_time2023-05-26 17:00:45
maintainer
docs_urlNone
authorGiovanni Lourenço
requires_python>=3.7
licenseMIT
keywords investment finances
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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][cvm-data-portal-co] 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

```py
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`:

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

  [cvm-data-portal-co]: <https://dados.cvm.gov.br/dataset/?groups=companhias>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/glourencoffee/pycvm/",
    "name": "pycvm",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "investment,finances",
    "author": "Giovanni Louren\u00e7o",
    "author_email": "gvnl.developer@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/0a/1c/f3f5dd5e836a79e3b4d67b7aa62169285722cab7ab9020adb7b614f048fe/pycvm-0.4.1.tar.gz",
    "platform": null,
    "description": "# About\n\n`cvm` is a Python library whose job is to extract data from publicly-held companies\nprovided by CVM, thus allowing its use in automated systems. The library was designed\nto be part of a software for analysis of public companies, although it may be used on\nits own for other purposes.\n\n# What is the CVM?\n\nCVM is the acronym for \"Comiss\u00e3o de Valores Mobili\u00e1rios\" (\"Securities and Exchange Commission\"),\nwhich is the government agency that defines the rules for publicly-held companies.\nIn addition to regulating such companies, CVM also makes their data available for\npublic access.\n\n# CVM Documents\n\nThe [CVM's Data Portal][cvm-data-portal-co] provides the following types\nof documents from publicly-held companies:\n- Registration Form (\"Formul\u00e1rio Cadastral\" or \"FCA\")\n- Standardized Financial Statements (\"Demonstra\u00e7\u00f5es Financeiras Padronizadas\" or \"DFP\")\n- Quarterly Information (\"Informa\u00e7\u00f5es Trimestrais\" or \"ITR\")\n- Reference Form (\"Formul\u00e1rio de Refer\u00eancia\" or \"FRE\")\n- Eventual and Periodical Reports (\"Informes Peri\u00f3dicos e Eventuais\" or \"IPE\")\n- Registration Information (\"Informa\u00e7\u00e3o Cadastral\" or \"CAD\")\n\nCurrently, this library supports the documents FCA, FRE (partial), DFP, and ITR.\n\n# Usage\n\n```py\nimport cvm\n\nwith cvm.FCAFile('path/to/fca.zip') as file:\n    for fca in file:\n        print(fca.company_name, 'sent an FCA document on', fca.receipt_date)\n\nwith cvm.DFPITRFile('path/to/dfp_or_itr.zip') as file:\n    for dfpitr in file:\n        print(dfpitr.company_name, 'sent a', dfpitr.type.name, 'document on', dfpitr.receipt_date)\n```\n\nNote that this library has not been thoroughly tested and its API is still unstable.\n\nMore elaborated examples are in the directory `samples`:\n\n```sh\n> python -m samples.dfp.print_accounts 'path/to/dfp_or_itr.zip'\n> python -m samples.dfp.print_balances 'path/to/dfp_or_itr.zip'\n```\n\n  [cvm-data-portal-co]: <https://dados.cvm.gov.br/dataset/?groups=companhias>\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python library for processing data from CVM",
    "version": "0.4.1",
    "project_urls": {
        "Homepage": "https://github.com/glourencoffee/pycvm/"
    },
    "split_keywords": [
        "investment",
        "finances"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81a9c28a035e98266001bab8bb043bdfa3656ecca3bb9c7c5053adfd73564c48",
                "md5": "c8eb13d6b73b69d0d76086250d31948f",
                "sha256": "dea46439b8ea85a6c4ce57e149e90e8ae939902ecd99a418d67e51ca8450bb4f"
            },
            "downloads": -1,
            "filename": "pycvm-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c8eb13d6b73b69d0d76086250d31948f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 79502,
            "upload_time": "2023-05-26T17:00:43",
            "upload_time_iso_8601": "2023-05-26T17:00:43.569391Z",
            "url": "https://files.pythonhosted.org/packages/81/a9/c28a035e98266001bab8bb043bdfa3656ecca3bb9c7c5053adfd73564c48/pycvm-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a1cf3f5dd5e836a79e3b4d67b7aa62169285722cab7ab9020adb7b614f048fe",
                "md5": "dcc6dfc3a3334fe5bb96883ddc42b1c1",
                "sha256": "15f32607748fefce4b4b1a3c11e236128667b0c7f52a45b7a6ed01692b053a13"
            },
            "downloads": -1,
            "filename": "pycvm-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "dcc6dfc3a3334fe5bb96883ddc42b1c1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 82419,
            "upload_time": "2023-05-26T17:00:45",
            "upload_time_iso_8601": "2023-05-26T17:00:45.672929Z",
            "url": "https://files.pythonhosted.org/packages/0a/1c/f3f5dd5e836a79e3b4d67b7aa62169285722cab7ab9020adb7b614f048fe/pycvm-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-26 17:00:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "glourencoffee",
    "github_project": "pycvm",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pycvm"
}
        
Elapsed time: 0.07121s