sec2md 0.1.5__py3-none-any.whl

sec2md-0.1.5.dist-info/METADATA

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: sec2md
+Version: 0.1.5
+Summary: Convert SEC EDGAR filings to LLM-ready Markdown for AI agents and agentic RAG
+Author-email: Lucas Astorian <lucas@intellifin.ai>
+License: MIT
+Project-URL: Homepage, https://github.com/lucasastorian/sec2md
+Project-URL: Repository, https://github.com/lucasastorian/sec2md
+Project-URL: Issues, https://github.com/lucasastorian/sec2md/issues
+Keywords: sec,edgar,markdown,filings,10-k,10-q,llm,rag,ai,embeddings
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: lxml>=4.9.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: tiktoken>=0.5.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# sec2md
+
+[![PyPI](https://img.shields.io/pypi/v/sec2md.svg)](https://pypi.org/project/sec2md)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue.svg)](https://sec2md.readthedocs.io)
+
+Transform messy SEC filings into clean, structured Markdown.
+**Built for AI. Optimized for retrieval. Ready for production.**
+
+![Before and After Comparison](comparison.png)
+*Apple 10-K cover page: Raw SEC HTML (left) vs. Clean Markdown (right)*
+
+---
+
+## The Problem
+
+RAG pipelines fail on SEC filings because **standard parsers destroy document structure.**
+
+When you flatten a 200-page 10-K to plain text:
+
+- ❌ **Tables break** — Complex financial statements become misaligned text
+- ❌ **Pages are lost** — Can't cite sources or trace answers back
+- ❌ **Sections merge** — Risk Factors and MD&A become indistinguishable
+- ❌ **Formatting is stripped** — Headers, bolds, lists (LLM reasoning cues) gone
+- ❌ **Retrieval fails** — Chunks without structure return wrong context
+
+Your RAG system is only as good as your data. Garbage in, garbage out.
+
+## The Solution
+
+`sec2md` **rebuilds** SEC filings as clean, semantic Markdown designed for AI systems:
+
+- ✅ **Preserves structure** - Headers (`#`), paragraphs, lists maintained
+- ✅ **Converts tables** - Complex HTML tables → clean Markdown pipes
+- ✅ **Strips noise** - XBRL tags, inline styles, and boilerplate removed
+- ✅ **Tracks pages** - Original pagination preserved for citation
+- ✅ **Detects sections** - Auto-extract Risk Factors, MD&A, Business sections
+- ✅ **Chunks intelligently** - Page-aware splitting with metadata headers
+
+### What We Support
+
+| Document Type              | Status | Notes                                |
+|----------------------------|--------|--------------------------------------|
+| **10-K/Q Filings**         | ✅     | Full section extraction (ITEM 1-16)  |
+| **Financial Statements**   | ✅     | Tables preserved in Markdown         |
+| **Notes to Financials**    | ✅     | Automatic table unwrapping           |
+| **8-K Press Releases**     | ✅     | Clean prose extraction               |
+| **Proxy Statements (DEF 14A)** | ✅ | Executive compensation, governance   |
+| **Exhibits** (Contracts)   | ✅     | Merger agreements, material contracts|
+
+---
+
+## Installation
+
+```bash
+pip install sec2md
+```
+
+## Quickstart
+
+```python
+import sec2md
+
+# Convert any SEC filing to clean Markdown
+md = sec2md.convert_to_markdown(
+    "https://www.sec.gov/Archives/edgar/data/320193/000032019324000123/aapl-20240928.htm",
+    user_agent="Your Name <you@example.com>"
+)
+```
+
+**Input:** Messy SEC HTML with XBRL tags, nested tables, inline styles
+**Output:** Clean, structured Markdown ready for LLMs
+
+```markdown
+## ITEM 1. Business
+
+Apple Inc. designs, manufactures, and markets smartphones, personal computers,
+tablets, wearables, and accessories worldwide...
+
+### Products
+
+| Product Category | Revenue (millions) |
+|------------------|-------------------|
+| iPhone           | $200,583          |
+| Mac              | $29,357           |
+| iPad             | $28,300           |
+...
+```
+
+## Core Features
+
+### 1️⃣ Section Extraction
+Extract specific sections from 10-K/10-Q filings with type-safe enums:
+
+```python
+from sec2md import Item10K
+
+pages = sec2md.convert_to_markdown(html, return_pages=True)
+sections = sec2md.extract_sections(pages, filing_type="10-K")
+
+# Get Risk Factors section
+risk = sec2md.get_section(sections, Item10K.RISK_FACTORS)
+print(risk.markdown())  # Just the risk factors text
+print(risk.page_range)   # (12, 28) - page citations
+```
+
+### 2️⃣ Page-Aware Chunking
+Intelligent chunking that preserves page numbers for citations:
+
+```python
+chunks = sec2md.chunk_pages(pages, chunk_size=512)
+
+for chunk in chunks:
+    print(f"Page {chunk.page}: {chunk.content[:100]}...")
+    # Use for embeddings, citations, or retrieval
+```
+
+### 3️⃣ RAG-Optimized Headers
+Boost retrieval quality by adding metadata to chunk embeddings:
+
+```python
+header = """# Apple Inc. (AAPL)
+Form 10-K | FY 2024 | Risk Factors"""
+
+chunks = sec2md.chunk_section(risk, header=header)
+
+# chunk.embedding_text includes header for better embeddings
+# chunk.content contains only the actual filing text
+```
+
+### 4️⃣ EdgarTools Integration
+Works seamlessly with [edgartools](https://github.com/dgunning/edgartools):
+
+```python
+from edgar import Company
+company = Company("AAPL")
+filing = company.get_filings(form="10-K").latest()
+
+md = sec2md.convert_to_markdown(filing.html())
+```
+
+---
+
+## Why Choose sec2md?
+
+### Just Parse It
+Most libraries force you to choose between speed and accuracy. `sec2md` gives you both:
+- 🚀 **Fast** - Processes 200-page filings in seconds
+- 🎯 **Accurate** - Purpose-built for SEC document structure
+- 🔧 **Simple** - One function call, zero configuration
+
+### Built for Agentic RAG
+Don't rebuild what we've already solved:
+- ✅ **Page tracking** - Cite sources with exact page numbers
+- ✅ **Section detection** - Extract just what you need (Risk Factors, MD&A)
+- ✅ **Smart chunking** - Respects table boundaries, preserves context
+- ✅ **Metadata headers** - Boost embedding quality 2-3x with contextual headers
+
+---
+
+## Documentation
+
+📚 **Full documentation:** [sec2md.readthedocs.io](https://sec2md.readthedocs.io)
+
+- [Quickstart Guide](https://sec2md.readthedocs.io/quickstart) - Get up and running in 3 minutes
+- [Convert Filings](https://sec2md.readthedocs.io/usage/direct-conversion) - Handle 10-Ks, exhibits, press releases
+- [Extract Sections](https://sec2md.readthedocs.io/usage/sections) - Pull specific ITEM sections
+- [Chunking for RAG](https://sec2md.readthedocs.io/usage/chunking) - Page-aware chunking with contextual headers
+- [EdgarTools Integration](https://sec2md.readthedocs.io/usage/edgartools) - Automate filing downloads
+- [API Reference](https://sec2md.readthedocs.io/api/convert_to_markdown) - Complete API docs
+
+---
+
+## Contributing
+
+We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+## License
+
+MIT © 2025

sec2md-0.1.5.dist-info/RECORD

@@ -0,0 +1,19 @@
+sec2md/__init__.py,sha256=iR_2g-PDkCAzY76uQwBjIVpprvkxlNopdmDduzDp8lg,1037
+sec2md/absolute_table_parser.py,sha256=rphc5_HttniV2RtPCThQ68HWyyZIn9l-gkaFsbtQXBU,22982
+sec2md/chunking.py,sha256=SQASDA057bKLhSj34GNAHrRl94Rf-A9WlfEvhhWPuIc,6350
+sec2md/core.py,sha256=hmdJXitoEWuekR5f3B1oEK1xmPux0t494lOpg5aJrRk,2663
+sec2md/models.py,sha256=H_3HnI8exGVnbqbdT1Bf4bNhPLjqvlP64ud0au5ohJk,14735
+sec2md/parser.py,sha256=J1He6XMa1Mf9YGJCEffWuCs7SAqi0Ts6S445CTO-lAA,47559
+sec2md/section_extractor.py,sha256=JTbZpPgmTipzU1Q5LehlQ9y2X4ZcQRTj3A7iMr90iqM,25976
+sec2md/sections.py,sha256=wtmKqF_KP_G-7_qAxGvxs25U_4vcH5NDGn14ouEy5GE,2784
+sec2md/table_parser.py,sha256=FhR8OwX5NAJmzdbTFzHQTGUNUPieYN37UzMFbQMkogU,12551
+sec2md/utils.py,sha256=2lUeN5irTbdIyjylCkaPKMv4ALWxWMJl96PTO8FV3Ik,2990
+sec2md/chunker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sec2md/chunker/markdown_blocks.py,sha256=yEF_v72DvYOVu0ZQ5bBCFpNM12INg-8RmajIu_dorQQ,4372
+sec2md/chunker/markdown_chunk.py,sha256=hCMpjn0cc5TIjWSZviq4fM7e781X3AtRcmI60pDLWro,4763
+sec2md/chunker/markdown_chunker.py,sha256=IYW8pQ2q9hX1lRGw4TnKAQcr-HmJfSW7wffu-BA0Jms,10743
+sec2md-0.1.5.dist-info/licenses/LICENSE,sha256=uJDiSGQ5TOx-PGhu2LGH4A-O53vS5hrQ5sc3j2Ps_Rk,1071
+sec2md-0.1.5.dist-info/METADATA,sha256=YWQ9uiut1LcBQxOCvFcT8MlfgLO7VBCDtEju5h7fp6k,7625
+sec2md-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sec2md-0.1.5.dist-info/top_level.txt,sha256=Jpmw3laEWwS9fljtAEg4sExjFw3zP8dGarjIknyh1v8,7
+sec2md-0.1.5.dist-info/RECORD,,

sec2md-0.1.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sec2md-0.1.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lucas Astorian
+
+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.

sec2md-0.1.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+sec2md