edgar-agent-tool 0.0.1__tar.gz

edgar_agent_tool-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

edgar_agent_tool-0.0.1/MANIFEST.in

@@ -0,0 +1,5 @@
+include settings.ini
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

edgar_agent_tool-0.0.1/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: edgar_agent_tool
+Version: 0.0.1
+Summary: A tool to read through filings on the EDGAR site from the SEC
+Home-page: https://github.com/problemsolversguild/edgar_agent_tool
+Author: Kevin Bird
+Author-email: kevin@problemsolversguild.com
+License: Apache Software License 2.0
+Keywords: nbdev jupyter notebook python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+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: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# edgar_tool
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Features
+
+- 🔍 **Company Lookup** — Convert stock tickers to SEC CIK numbers
+- 📑 **Filing Retrieval** — Fetch recent filings for any public
+  company  
+- 🧩 **Automatic Section Parsing** — Extract specific sections (Risk
+  Factors, MD&A, etc.)
+- 🌐 **Cross-Company Search** — Find filings across all companies by
+  date
+- 🤖 **LLM-Friendly** — Clean markdown output, structured returns,
+  designed for AI agents
+- ⚡ **Smart Caching** — Built-in TTL caches to respect SEC rate limits
+
+## Developer Guide
+
+If you are new to using `nbdev` here are some useful pointers to get you
+started.
+
+### Install edgar_tool in Development mode
+
+``` sh
+# make sure edgar_tool package is installed in development mode
+$ pip install -e .
+
+# make changes under nbs/ directory
+# ...
+
+# compile to have changes apply to edgar_tool
+$ nbdev_prepare
+```
+
+## Usage
+
+## Installation
+
+``` bash
+pip install edgar_tool
+```
+
+Or install from GitHub for the latest version:
+
+``` bash
+pip install git+https://github.com/problemsolversguild/edgar_tool.git
+```
+
+### Documentation
+
+Documentation can be found hosted on this GitHub
+[repository](https://github.com/problemsolversguild/edgar_tool)’s
+[pages](https://problemsolversguild.github.io/edgar_tool/). Additionally
+you can find package manager specific guidelines on
+[conda](https://anaconda.org/problemsolversguild/edgar_tool) and
+[pypi](https://pypi.org/project/edgar_tool/) respectively.
+
+## Quick Start
+
+First, set up your SEC User-Agent (required by SEC):
+
+``` bash
+export SEC_USER_AGENT="YourName your@email.com"
+```
+
+``` python
+from edgar_tool.filings import get_filing, get_recent_filings
+
+# Get Apple's latest 10-K with automatic section parsing
+filing = get_filing("AAPL", filing_type="10-K")
+print(filing["summary"])
+```
+
+    10-K Filed: 2025-10-31 | Report Date: 2025-09-27
+    Ticker: AAPL | CIK: 320193
+
+    Items found: 23
+
+    Part I:
+      • Item 1: Business
+      • Item 1A: Risk Factors
+      • Item 1B: Unresolved Staff Comments
+      • Item 1C: Cybersecurity
+      • Item 2: Properties
+      • Item 3: Legal Proceedings
+      • Item 4: Mine Safety Disclosures
+
+    Part II:
+      • Item 5: Market for Registrant's Common Equity
+      • Item 6: [Reserved]
+      • Item 7: Management's Discussion and Analysis (MD&A)
+      • Item 7A: Quantitative and Qualitative Disclosures About Market Risk
+      • Item 8: Financial Statements and Supplementary Data
+      • Item 9: Changes in and Disagreements with Accountants
+      • Item 9A: Controls and Procedures
+      • Item 9B: Other Information
+      • Item 9C: Disclosure Regarding Foreign Jurisdictions
+
+    Part III:
+      • Item 10: Directors, Executive Officers and Corporate Governance
+      • Item 11: Executive Compensation
+      • Item 12: Security Ownership of Certain Beneficial Owners
+      • Item 13: Certain Relationships and Related Transactions
+      • Item 14: Principal Accountant Fees and Services
+
+    Part IV:
+      • Item 15: Exhibits and Financial Statement Schedules
+      • Item 16: Form 10-K Summary
+
+``` python
+# Extract a specific section (e.g., Risk Factors)
+filing = get_filing("AAPL", filing_type="10-K", section="1A")
+print(f"Risk Factors: {len(filing['section']['content'])} characters")
+```
+
+    Risk Factors: 68281 characters
+
+``` python
+# Get a list of recent 8-K filings
+filings = get_recent_filings("MSFT", filing_type="8-K", count=5)
+for f in filings:
+    print(f"{f['filingDate']}: {f['form']} - {f['primaryDocDescription']} - {f['items']}")
+```
+
+    2025-12-08: 8-K - 8-K - 5.02,5.07
+    2025-10-29: 8-K - 8-K - 2.02,7.01,9.01
+    2025-09-30: 8-K - 8-K - 5.02
+    2025-07-30: 8-K - 8-K - 2.02,9.01
+    2025-07-01: 8-K - 8-K - 5.03,9.01
+
+## Key Functions
+
+| Function | Description |
+|----|----|
+| `get_filing(ticker, filing_type, section)` | Get a parsed filing with automatic section extraction |
+| `get_recent_filings(ticker, filing_type, count)` | List recent filings for a company |
+| `get_latest_filings(filing_type, start_date, end_date)` | Search filings across all companies |
+| `ticker_to_cik(ticker)` | Convert ticker to SEC CIK number |
+| `get_filing_document(url)` | Fetch raw filing content as markdown |
+
+## Filing Classes
+
+For more control, use the typed filing classes directly:
+
+| Class | Description |
+|----|----|
+| [`Filing10K`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing10k) | Annual reports with 23 standard items across 4 parts |
+| [`Filing10Q`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing10q) | Quarterly reports with financial statements and MD&A |
+| [`Filing8K`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing8k) | Current reports for material events (earnings, exec changes, etc.) |
+
+Each class provides: - **Lazy content loading** — Content fetched only
+when accessed - **Automatic section parsing** — Structured access to all
+standard items - **Convenience properties** — `.business`,
+`.risk_factors`, `.mda`, `.financials` - **Summary generation** —
+Human-readable filing overviews
+
+## Section Reference
+
+### 10-K Sections
+
+- **Item 1**: Business description
+- **Item 1A**: Risk Factors ⭐
+- **Item 7**: Management’s Discussion & Analysis (MD&A) ⭐
+- **Item 8**: Financial Statements ⭐
+
+### 10-Q Sections
+
+- **I-1**: Financial Statements
+- **I-2**: MD&A ⭐
+- **II-1A**: Risk Factor updates
+
+### 8-K Items
+
+- **2.02**: Results of Operations (earnings) ⭐
+- **5.02**: Director/Officer changes
+- **7.01**: Regulation FD Disclosure
+- **8.01**: Other Events
+
+Ok, how is that looking?

edgar_agent_tool-0.0.1/README.md

@@ -0,0 +1,181 @@
+# edgar_tool
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Features
+
+- 🔍 **Company Lookup** — Convert stock tickers to SEC CIK numbers
+- 📑 **Filing Retrieval** — Fetch recent filings for any public
+  company  
+- 🧩 **Automatic Section Parsing** — Extract specific sections (Risk
+  Factors, MD&A, etc.)
+- 🌐 **Cross-Company Search** — Find filings across all companies by
+  date
+- 🤖 **LLM-Friendly** — Clean markdown output, structured returns,
+  designed for AI agents
+- ⚡ **Smart Caching** — Built-in TTL caches to respect SEC rate limits
+
+## Developer Guide
+
+If you are new to using `nbdev` here are some useful pointers to get you
+started.
+
+### Install edgar_tool in Development mode
+
+``` sh
+# make sure edgar_tool package is installed in development mode
+$ pip install -e .
+
+# make changes under nbs/ directory
+# ...
+
+# compile to have changes apply to edgar_tool
+$ nbdev_prepare
+```
+
+## Usage
+
+## Installation
+
+``` bash
+pip install edgar_tool
+```
+
+Or install from GitHub for the latest version:
+
+``` bash
+pip install git+https://github.com/problemsolversguild/edgar_tool.git
+```
+
+### Documentation
+
+Documentation can be found hosted on this GitHub
+[repository](https://github.com/problemsolversguild/edgar_tool)’s
+[pages](https://problemsolversguild.github.io/edgar_tool/). Additionally
+you can find package manager specific guidelines on
+[conda](https://anaconda.org/problemsolversguild/edgar_tool) and
+[pypi](https://pypi.org/project/edgar_tool/) respectively.
+
+## Quick Start
+
+First, set up your SEC User-Agent (required by SEC):
+
+``` bash
+export SEC_USER_AGENT="YourName your@email.com"
+```
+
+``` python
+from edgar_tool.filings import get_filing, get_recent_filings
+
+# Get Apple's latest 10-K with automatic section parsing
+filing = get_filing("AAPL", filing_type="10-K")
+print(filing["summary"])
+```
+
+    10-K Filed: 2025-10-31 | Report Date: 2025-09-27
+    Ticker: AAPL | CIK: 320193
+
+    Items found: 23
+
+    Part I:
+      • Item 1: Business
+      • Item 1A: Risk Factors
+      • Item 1B: Unresolved Staff Comments
+      • Item 1C: Cybersecurity
+      • Item 2: Properties
+      • Item 3: Legal Proceedings
+      • Item 4: Mine Safety Disclosures
+
+    Part II:
+      • Item 5: Market for Registrant's Common Equity
+      • Item 6: [Reserved]
+      • Item 7: Management's Discussion and Analysis (MD&A)
+      • Item 7A: Quantitative and Qualitative Disclosures About Market Risk
+      • Item 8: Financial Statements and Supplementary Data
+      • Item 9: Changes in and Disagreements with Accountants
+      • Item 9A: Controls and Procedures
+      • Item 9B: Other Information
+      • Item 9C: Disclosure Regarding Foreign Jurisdictions
+
+    Part III:
+      • Item 10: Directors, Executive Officers and Corporate Governance
+      • Item 11: Executive Compensation
+      • Item 12: Security Ownership of Certain Beneficial Owners
+      • Item 13: Certain Relationships and Related Transactions
+      • Item 14: Principal Accountant Fees and Services
+
+    Part IV:
+      • Item 15: Exhibits and Financial Statement Schedules
+      • Item 16: Form 10-K Summary
+
+``` python
+# Extract a specific section (e.g., Risk Factors)
+filing = get_filing("AAPL", filing_type="10-K", section="1A")
+print(f"Risk Factors: {len(filing['section']['content'])} characters")
+```
+
+    Risk Factors: 68281 characters
+
+``` python
+# Get a list of recent 8-K filings
+filings = get_recent_filings("MSFT", filing_type="8-K", count=5)
+for f in filings:
+    print(f"{f['filingDate']}: {f['form']} - {f['primaryDocDescription']} - {f['items']}")
+```
+
+    2025-12-08: 8-K - 8-K - 5.02,5.07
+    2025-10-29: 8-K - 8-K - 2.02,7.01,9.01
+    2025-09-30: 8-K - 8-K - 5.02
+    2025-07-30: 8-K - 8-K - 2.02,9.01
+    2025-07-01: 8-K - 8-K - 5.03,9.01
+
+## Key Functions
+
+| Function | Description |
+|----|----|
+| `get_filing(ticker, filing_type, section)` | Get a parsed filing with automatic section extraction |
+| `get_recent_filings(ticker, filing_type, count)` | List recent filings for a company |
+| `get_latest_filings(filing_type, start_date, end_date)` | Search filings across all companies |
+| `ticker_to_cik(ticker)` | Convert ticker to SEC CIK number |
+| `get_filing_document(url)` | Fetch raw filing content as markdown |
+
+## Filing Classes
+
+For more control, use the typed filing classes directly:
+
+| Class | Description |
+|----|----|
+| [`Filing10K`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing10k) | Annual reports with 23 standard items across 4 parts |
+| [`Filing10Q`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing10q) | Quarterly reports with financial statements and MD&A |
+| [`Filing8K`](https://problemsolversguild.github.io/edgar_tool/filings.html#filing8k) | Current reports for material events (earnings, exec changes, etc.) |
+
+Each class provides: - **Lazy content loading** — Content fetched only
+when accessed - **Automatic section parsing** — Structured access to all
+standard items - **Convenience properties** — `.business`,
+`.risk_factors`, `.mda`, `.financials` - **Summary generation** —
+Human-readable filing overviews
+
+## Section Reference
+
+### 10-K Sections
+
+- **Item 1**: Business description
+- **Item 1A**: Risk Factors ⭐
+- **Item 7**: Management’s Discussion & Analysis (MD&A) ⭐
+- **Item 8**: Financial Statements ⭐
+
+### 10-Q Sections
+
+- **I-1**: Financial Statements
+- **I-2**: MD&A ⭐
+- **II-1A**: Risk Factor updates
+
+### 8-K Items
+
+- **2.02**: Results of Operations (earnings) ⭐
+- **5.02**: Director/Officer changes
+- **7.01**: Regulation FD Disclosure
+- **8.01**: Other Events
+
+Ok, how is that looking?

edgar_agent_tool-0.0.1/edgar_agent_tool/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1"