Metadata-Version: 2.4
Name: filings-cvm
Version: 0.1.0
Summary: Simple and efficient Python library to interact with CVM regulatory filings.
License: MIT
License-File: LICENSE
Keywords: filings-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: Topic :: Software Development :: Libraries
Requires-Dist: openpyxl (>=3.1.0)
Requires-Dist: pandas (>=2.1.0)
Requires-Dist: pydantic (>=2.6,<3)
Project-URL: Bug Reports, https://github.com/guilhermegor/filings-cvm/issues
Project-URL: Documentation, https://guilhermegor.github.io/filings-cvm/
Project-URL: Homepage, https://guilhermegor.github.io/filings-cvm/
Project-URL: Repository, https://github.com/guilhermegor/filings-cvm
Project-URL: Source, https://github.com/guilhermegor/filings-cvm
Description-Content-Type: text/markdown

# Filings Cvm <img src="assets/logo_lorem_ipsum.png" align="right" width="200" style="border-radius: 15px;" alt="Filings Cvm">

[![Project Status: Active](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
![Python Version](https://img.shields.io/badge/python-${PYTHON_VERSIONS}-blue.svg)
![PyPI Version](https://img.shields.io/pypi/v/${PYPI_NAME})
[![Snyk Vulnerabilities](https://snyk.io/test/github/${GITHUB_USERNAME}/${PROJECT_SLUG}/badge.svg)](https://snyk.io/test/github/${GITHUB_USERNAME}/${PROJECT_SLUG})
[![Snyk License](https://snyk.io/advisor/python/${PYPI_NAME}/badge.svg)](https://snyk.io/advisor/python/${PYPI_NAME})
![PyPI Downloads](https://static.pepy.tech/badge/${PYPI_NAME})
[![Linting](https://img.shields.io/badge/linting-ruff_|_codespell-blue)](https://github.com/astral-sh/ruff+https://github.com/codespell-project/codespell)
![Formatting: isort](https://img.shields.io/badge/formatting-isort-%231674b1)
![Test Coverage](./coverage.svg)
![License](https://img.shields.io/badge/license-${PROJECT_LICENSE}-green.svg)
![Open Issues](https://img.shields.io/github/issues/${GITHUB_USERNAME}/${PROJECT_SLUG})
![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-darkgreen.svg)

${PROJECT_DESCRIPTION}

## ✨ Key Features

> Replace these placeholder groups with your project's actual capabilities.
> Group features by domain or capability — one `###` heading per area.

### 🧩 Capability Group 1
- [Feature placeholder 1](${LINK_PLACEHOLDER})
- [Feature placeholder 2](${LINK_PLACEHOLDER})
- [Feature placeholder 3](${LINK_PLACEHOLDER})

### 🧩 Capability Group 2
- [Feature placeholder 4](${LINK_PLACEHOLDER})
- [Feature placeholder 5](${LINK_PLACEHOLDER})
- [Feature placeholder 6](${LINK_PLACEHOLDER})

### ⚙️ Utilities
- [Utility placeholder 1](${LINK_PLACEHOLDER})
- [Utility placeholder 2](${LINK_PLACEHOLDER})

## 🚀 Getting Started

### Prerequisites
- Python ${PYTHON_VERSIONS}
- Poetry (recommended)
- Optional: Makefile

### Installation

**Option 1: Pip (recommended)**
```bash
pip install ${PYPI_NAME}
```

**Option 2: Build from source**
```bash
git clone https://github.com/${GITHUB_USERNAME}/${PROJECT_SLUG}.git
cd ${PROJECT_SLUG}
pyenv install ${PYTHON_VERSION_PIN}
pyenv local ${PYTHON_VERSION_PIN}
poetry install --no-root
poetry shell
```

**Make (optional automation)**
- Windows: install via MinGW or Chocolatey
- macOS: Xcode CLI tools or Homebrew
- Linux: sudo apt-get install build-essential

### Running Tests
```bash
poetry run pytest tests/unit/ -v
poetry run pytest tests/integration/ -v
```

## 📂 Project Structure (template)
```
${PROJECT_SLUG}/
├── .github/
│   ├── workflows/
│   ├── CODEOWNERS
│   └── PULL_REQUEST_TEMPLATE.md
├── .vscode/
├── bin/
│   ├── check_unix_filenames.sh
│   ├── fix_playwright.sh
│   ├── start.sh
│   └── test_urls_docstrings.sh
├── data/
├── docs/
├── examples/
├── img/
├── assets/
│   └── logo.png
├── src/${PACKAGE_IMPORT_PATH}/
├── tests/
│   ├── unit/
│   ├── integration/
│   └── performance/
├── .gitignore
├── .pre-commit-config.yaml
├── .python-version
├── LICENSE
├── Makefile
├── poetry.lock
├── pyproject.toml
├── README.md
├── requirements.txt
└── requirements-prd.txt
```

## 👨‍💻 Authors
- ${AUTHOR_NAME} — [GitHub](https://github.com/${GITHUB_USERNAME}) | [LinkedIn](${LINKEDIN_URL})

## 📜 License
This project is licensed under ${PROJECT_LICENSE}. Update this section if you use a different license.

## 🙌 Acknowledgments
- Inspired by relevant open-source work.
- Thank contributors and the community.

## 🔗 Useful Links
- [GitHub Repository](https://github.com/${GITHUB_USERNAME}/${PROJECT_SLUG})
- [Issue Tracker](https://github.com/${GITHUB_USERNAME}/${PROJECT_SLUG}/issues)

