layouts-cvm 0.1.0__tar.gz

layouts_cvm-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 guilhermegor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

layouts_cvm-0.1.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: layouts-cvm
+Version: 0.1.0
+Summary: Build, validate and serialise the files a fund sends to CVM, in CVM's own file layouts.
+License: MIT
+License-File: LICENSE
+Keywords: layouts-cvm,python,library
+Author: guilhermegor
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: beartype (>=0.22)
+Requires-Dist: defusedxml (>=0.7)
+Requires-Dist: numpy (>=1.22)
+Requires-Dist: openpyxl (>=3.1.0)
+Requires-Dist: pandas (>=2.1.0)
+Requires-Dist: pydantic (>=2.0)
+Project-URL: Bug Reports, https://github.com/guilhermegor/layouts-cvm/issues
+Project-URL: Documentation, https://guilhermegor.github.io/layouts-cvm/
+Project-URL: Homepage, https://guilhermegor.github.io/layouts-cvm/
+Project-URL: Repository, https://github.com/guilhermegor/layouts-cvm
+Project-URL: Source, https://github.com/guilhermegor/layouts-cvm
+Description-Content-Type: text/markdown
+
+<!-- readme-archetype: library -->
+# layouts-cvm
+
+<p align="center"><img src="https://raw.githubusercontent.com/guilhermegor/layouts-cvm/main/assets/cvm-logo.png" width="200" alt="CVM emblem"></p>
+
+[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)
+![PyPI Version](https://img.shields.io/pypi/v/layouts-cvm)
+[![Snyk Vulnerabilities](https://snyk.io/test/github/guilhermegor/layouts-cvm/badge.svg)](https://snyk.io/test/github/guilhermegor/layouts-cvm)
+[![Snyk License](https://snyk.io/advisor/python/layouts-cvm/badge.svg)](https://snyk.io/advisor/python/layouts-cvm)
+![PyPI Downloads](https://static.pepy.tech/badge/layouts-cvm)
+[![PyPI](https://img.shields.io/pypi/v/layouts-cvm.svg)](https://pypi.org/project/layouts-cvm/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://guilhermegor.github.io/layouts-cvm/)
+[![Linting](https://img.shields.io/badge/linting-ruff_|_codespell-blue)](https://github.com/astral-sh/ruff)
+[![Mypy](https://img.shields.io/badge/type_checked-mypy-blue)](https://mypy-lang.org)
+![Test Coverage](https://raw.githubusercontent.com/guilhermegor/layouts-cvm/main/coverage.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Open Issues](https://img.shields.io/github/issues/guilhermegor/layouts-cvm)
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-darkgreen.svg)
+
+<!-- slug: overview -->
+## Overview
+
+Build, validate and serialise the files a fund sends to CVM, in CVM's own file layouts.
+
+<!-- optional section: delete it when the project has no feature list -->
+<!-- slug: features -->
+## Features
+
+- Pydantic models for 14 CVM XML layouts, validated before anything is serialised.
+- One writer per layout (`export(doc, output_path=None)`), producing windows-1252 XML.
+- Byte-identical to the original `filings-cvm` writers, pinned by a golden-file test.
+- Runtime dependencies: `pydantic` and `beartype`. No network.
+
+| Layout | Writer | Document |
+|---|---|---|
+| Atualização do Cadastro de Ativos | `CadastroAtivos` | `CadastroAtivosDocument` |
+| CDA V4 | `Cda` | `CdaDocument` |
+| Extrato das Informações sobre o Fundo V3 | `Extrato` | `ExtratoDocument` |
+| Informe de Fundo 157 | `InfFundo157` | `InfFundo157Document` |
+| Informe Mensal FIDC (ICVM 576) | `InfMensalFidc` | `InfMensalFidcDocument` |
+| Informe Diário V4 | `InformeDiario` | `InformeDiarioDocument` |
+| Informe Diário V3 | `InformeDiarioV3` | `InformeDiarioV3Document` |
+| Informe de Portabilidade | `InformePortabilidade` | `InformePortabilidadeDocument` |
+| Informe Quadrimestral V2 | `InformeQuadrimestral` | `InformeQuadrimestralDocument` |
+| Informe Trimestral V1 | `InformeTrimestralV1` | `InformeTrimestralV1Document` |
+| Informe Mensal de Investidor Não Residente | `InrMensal` | `InrMensalDocument` |
+| Lâmina de Fundos V3 | `Lamina` | `LaminaDocument` |
+| Perfil Mensal V4 | `PerfilMensal` | `PerfilMensalDocument` |
+| Perfil Mensal (original) | `PerfilMensalOriginal` | `PerfilMensalOriginalDocument` |
+
+<!-- slug: documentation -->
+## Documentation
+
+The documentation site lives at https://guilhermegor.github.io/layouts-cvm/. Serve it locally with `bash bin/poe_exec.sh docs_serve`.
+
+<!-- slug: getting-started -->
+## Getting Started
+
+Python 3.10+ is the only prerequisite; `bin/venv.sh` installs [Poetry](https://python-poetry.org/) when it is missing.
+
+<!-- slug: install -->
+### Install
+
+```bash
+git clone https://github.com/guilhermegor/layouts-cvm.git
+cd layouts-cvm
+bash bin/venv.sh
+bash bin/poe_exec.sh init
+```
+
+`poe` lives inside the virtualenv, so `bin/venv.sh` creates it first; `bin/poe_exec.sh` then
+runs `poe init` without activating anything. Once the virtualenv exists, `poetry run poe init`
+does the same.
+
+<!-- slug: usage -->
+### Usage
+
+```python
+from layouts_cvm import InformeDiario, InformeDiarioDocument
+
+doc = InformeDiarioDocument.model_validate(dict_payload)
+xml = InformeDiario().export(doc)                      # returns the XML text
+InformeDiario().export(doc, "informe_diario.xml")      # or writes it, atomically
+```
+
+Each layout has its own page under the Layouts section of the documentation.
+
+<!-- slug: project-structure -->
+## Project Structure
+
+```text
+layouts-cvm/
+├── .github/        workflows, CODEOWNERS, PR template
+├── .specs/         feature specs and backlog trackers
+├── bin/            gate scripts and helpers
+├── docs/           published documentation
+├── src/            application code
+├── tests/
+│   ├── unit/
+│   └── integration/
+├── pyproject.toml
+└── poe_tasks.toml  task runner entry points
+```
+
+<!-- slug: development -->
+## Development
+
+After the bootstrap under Install, any task can be run with the bootstrap script:
+`bash bin/poe_exec.sh <task>`, and `bash bin/poe_exec.sh` with no task lists them.
+
+```bash
+bash bin/poe_exec.sh unit_tests
+bash bin/poe_exec.sh integration_tests
+```
+
+Once the first release's docs deploy has created the `gh-pages` branch, run
+`bash bin/poe_exec.sh enable_pages` once: until that branch exists, `init` leaves Pages untouched.
+
+<!-- slug: public-api -->
+## Public API
+
+The public surface is whatever the package `__init__.py` lists in `__all__`; everything
+under `_internal/` is private.
+
+<!-- slug: publishing -->
+## Publishing
+
+Releases go out from the release workflows under `.github/workflows/`; the git tag is the
+version.
+
+The path from 0.x to 1.0.0, and the release gate that guards it, is in
+[docs/releasing-1-0-0.md](docs/releasing-1-0-0.md).
+
+<!-- slug: contributing -->
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the branch, commit and review rules.
+
+<!-- slug: license -->
+## License
+
+This project is licensed under MIT; see [LICENSE](LICENSE).
+
+<!-- slug: authors -->
+## Authors
+
+- Guilherme Rodrigues — [GitHub](https://github.com/guilhermegor) | [LinkedIn](https://www.linkedin.com/in/guilhermegor/)
+
+<!-- slug: useful-links -->
+## Useful Links
+
+- [GitHub Repository](https://github.com/guilhermegor/layouts-cvm)
+- [Issue Tracker](https://github.com/guilhermegor/layouts-cvm/issues)
+- [Documentation](https://guilhermegor.github.io/layouts-cvm/)
+
+---
+
+<sub>Generated from the lib-minimal template via [BlueprintX](https://github.com/guilhermegor/blueprintx).
+Unofficial, community library. Not affiliated with or endorsed by the Comissão de Valores Mobiliários (CVM);
+the emblem is theirs and is not covered by this project's MIT license.</sub>
+

layouts_cvm-0.1.0/README.md

@@ -0,0 +1,161 @@
+<!-- readme-archetype: library -->
+# layouts-cvm
+
+<p align="center"><img src="https://raw.githubusercontent.com/guilhermegor/layouts-cvm/main/assets/cvm-logo.png" width="200" alt="CVM emblem"></p>
+
+[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)
+![PyPI Version](https://img.shields.io/pypi/v/layouts-cvm)
+[![Snyk Vulnerabilities](https://snyk.io/test/github/guilhermegor/layouts-cvm/badge.svg)](https://snyk.io/test/github/guilhermegor/layouts-cvm)
+[![Snyk License](https://snyk.io/advisor/python/layouts-cvm/badge.svg)](https://snyk.io/advisor/python/layouts-cvm)
+![PyPI Downloads](https://static.pepy.tech/badge/layouts-cvm)
+[![PyPI](https://img.shields.io/pypi/v/layouts-cvm.svg)](https://pypi.org/project/layouts-cvm/)
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://guilhermegor.github.io/layouts-cvm/)
+[![Linting](https://img.shields.io/badge/linting-ruff_|_codespell-blue)](https://github.com/astral-sh/ruff)
+[![Mypy](https://img.shields.io/badge/type_checked-mypy-blue)](https://mypy-lang.org)
+![Test Coverage](https://raw.githubusercontent.com/guilhermegor/layouts-cvm/main/coverage.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Open Issues](https://img.shields.io/github/issues/guilhermegor/layouts-cvm)
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-darkgreen.svg)
+
+<!-- slug: overview -->
+## Overview
+
+Build, validate and serialise the files a fund sends to CVM, in CVM's own file layouts.
+
+<!-- optional section: delete it when the project has no feature list -->
+<!-- slug: features -->
+## Features
+
+- Pydantic models for 14 CVM XML layouts, validated before anything is serialised.
+- One writer per layout (`export(doc, output_path=None)`), producing windows-1252 XML.
+- Byte-identical to the original `filings-cvm` writers, pinned by a golden-file test.
+- Runtime dependencies: `pydantic` and `beartype`. No network.
+
+| Layout | Writer | Document |
+|---|---|---|
+| Atualização do Cadastro de Ativos | `CadastroAtivos` | `CadastroAtivosDocument` |
+| CDA V4 | `Cda` | `CdaDocument` |
+| Extrato das Informações sobre o Fundo V3 | `Extrato` | `ExtratoDocument` |
+| Informe de Fundo 157 | `InfFundo157` | `InfFundo157Document` |
+| Informe Mensal FIDC (ICVM 576) | `InfMensalFidc` | `InfMensalFidcDocument` |
+| Informe Diário V4 | `InformeDiario` | `InformeDiarioDocument` |
+| Informe Diário V3 | `InformeDiarioV3` | `InformeDiarioV3Document` |
+| Informe de Portabilidade | `InformePortabilidade` | `InformePortabilidadeDocument` |
+| Informe Quadrimestral V2 | `InformeQuadrimestral` | `InformeQuadrimestralDocument` |
+| Informe Trimestral V1 | `InformeTrimestralV1` | `InformeTrimestralV1Document` |
+| Informe Mensal de Investidor Não Residente | `InrMensal` | `InrMensalDocument` |
+| Lâmina de Fundos V3 | `Lamina` | `LaminaDocument` |
+| Perfil Mensal V4 | `PerfilMensal` | `PerfilMensalDocument` |
+| Perfil Mensal (original) | `PerfilMensalOriginal` | `PerfilMensalOriginalDocument` |
+
+<!-- slug: documentation -->
+## Documentation
+
+The documentation site lives at https://guilhermegor.github.io/layouts-cvm/. Serve it locally with `bash bin/poe_exec.sh docs_serve`.
+
+<!-- slug: getting-started -->
+## Getting Started
+
+Python 3.10+ is the only prerequisite; `bin/venv.sh` installs [Poetry](https://python-poetry.org/) when it is missing.
+
+<!-- slug: install -->
+### Install
+
+```bash
+git clone https://github.com/guilhermegor/layouts-cvm.git
+cd layouts-cvm
+bash bin/venv.sh
+bash bin/poe_exec.sh init
+```
+
+`poe` lives inside the virtualenv, so `bin/venv.sh` creates it first; `bin/poe_exec.sh` then
+runs `poe init` without activating anything. Once the virtualenv exists, `poetry run poe init`
+does the same.
+
+<!-- slug: usage -->
+### Usage
+
+```python
+from layouts_cvm import InformeDiario, InformeDiarioDocument
+
+doc = InformeDiarioDocument.model_validate(dict_payload)
+xml = InformeDiario().export(doc)                      # returns the XML text
+InformeDiario().export(doc, "informe_diario.xml")      # or writes it, atomically
+```
+
+Each layout has its own page under the Layouts section of the documentation.
+
+<!-- slug: project-structure -->
+## Project Structure
+
+```text
+layouts-cvm/
+├── .github/        workflows, CODEOWNERS, PR template
+├── .specs/         feature specs and backlog trackers
+├── bin/            gate scripts and helpers
+├── docs/           published documentation
+├── src/            application code
+├── tests/
+│   ├── unit/
+│   └── integration/
+├── pyproject.toml
+└── poe_tasks.toml  task runner entry points
+```
+
+<!-- slug: development -->
+## Development
+
+After the bootstrap under Install, any task can be run with the bootstrap script:
+`bash bin/poe_exec.sh <task>`, and `bash bin/poe_exec.sh` with no task lists them.
+
+```bash
+bash bin/poe_exec.sh unit_tests
+bash bin/poe_exec.sh integration_tests
+```
+
+Once the first release's docs deploy has created the `gh-pages` branch, run
+`bash bin/poe_exec.sh enable_pages` once: until that branch exists, `init` leaves Pages untouched.
+
+<!-- slug: public-api -->
+## Public API
+
+The public surface is whatever the package `__init__.py` lists in `__all__`; everything
+under `_internal/` is private.
+
+<!-- slug: publishing -->
+## Publishing
+
+Releases go out from the release workflows under `.github/workflows/`; the git tag is the
+version.
+
+The path from 0.x to 1.0.0, and the release gate that guards it, is in
+[docs/releasing-1-0-0.md](docs/releasing-1-0-0.md).
+
+<!-- slug: contributing -->
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the branch, commit and review rules.
+
+<!-- slug: license -->
+## License
+
+This project is licensed under MIT; see [LICENSE](LICENSE).
+
+<!-- slug: authors -->
+## Authors
+
+- Guilherme Rodrigues — [GitHub](https://github.com/guilhermegor) | [LinkedIn](https://www.linkedin.com/in/guilhermegor/)
+
+<!-- slug: useful-links -->
+## Useful Links
+
+- [GitHub Repository](https://github.com/guilhermegor/layouts-cvm)
+- [Issue Tracker](https://github.com/guilhermegor/layouts-cvm/issues)
+- [Documentation](https://guilhermegor.github.io/layouts-cvm/)
+
+---
+
+<sub>Generated from the lib-minimal template via [BlueprintX](https://github.com/guilhermegor/blueprintx).
+Unofficial, community library. Not affiliated with or endorsed by the Comissão de Valores Mobiliários (CVM);
+the emblem is theirs and is not covered by this project's MIT license.</sub>

layouts_cvm-0.1.0/pyproject.toml

@@ -0,0 +1,76 @@
+[tool.poetry]
+name = "layouts-cvm"
+version = "0.1.0"  # set from the git tag, see docs/contributing.md#releasing
+description = "Build, validate and serialise the files a fund sends to CVM, in CVM's own file layouts."
+authors = ["guilhermegor"]
+readme = "README.md"
+license = "MIT"
+homepage = "https://guilhermegor.github.io/layouts-cvm/"
+documentation = "https://guilhermegor.github.io/layouts-cvm/"
+repository = "https://github.com/guilhermegor/layouts-cvm"
+keywords = ["layouts-cvm", "python", "library"]
+packages = [{ include = "layouts_cvm", from = "src" }]
+exclude = ["src/**/CLAUDE.md"]
+package-mode = true
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+]
+
+[tool.poetry.urls]
+"Bug Reports" = "https://github.com/guilhermegor/layouts-cvm/issues"
+"Source" = "https://github.com/guilhermegor/layouts-cvm"
+"Documentation" = "https://guilhermegor.github.io/layouts-cvm/"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+beartype = ">=0.22"
+pandas = ">=2.1.0"
+numpy = ">=1.22"
+openpyxl = ">=3.1.0"
+defusedxml = ">=0.7"
+pydantic = ">=2.0"
+
+[tool.poetry.group.dev.dependencies]
+poethepoet = ">=0.35"
+pre-commit = ">=4.1.0"
+pretty-errors = ">=1.2.25"
+commitizen = ">=4.4.1"
+build = ">=1.2.2"
+twine = ">=6.1.0"
+ruff = ">=0.11.13,<0.12"
+codespell = ">=2.4.1"
+pydocstyle = ">=6.3.0"
+pytest = ">=8.0.0"
+pytest-cov = ">=6.0.0"
+pytest-randomly = ">=3.15.0"
+coverage = ">=7.6.0"
+genbadge = {extras = ["coverage"], version = ">=1.1.0"}
+mypy = ">=1.8.0"
+sqlfluff = ">=3.0.0"
+yamllint = ">=1.35.0"
+shfmt-py = ">=3.7.0"
+shellcheck-py = ">=0.10.0"
+deptry = ">=0.20"
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = ">=1.6.0"
+mkdocs-material = ">=9.5.0"
+pymdown-extensions = ">=10.0"
+mike = ">=2.1.0"
+
+[tool.deptry.per_rule_ignores]
+DEP002 = ["openpyxl"]
+
+[tool.poetry-dynamic-versioning]
+enable = false
+vcs = "git"
+style = "pep440"
+
+[build-system]
+requires = ["poetry-core>=1.7.0", "poetry-dynamic-versioning>=1.4.0,<2.0.0"]
+build-backend = "poetry_dynamic_versioning.backend"