docs

Author: john-friedman

datamule/datamule/book/s3transfer.py

@@ -226,8 +226,7 @@ def transfer_cached_urls_to_s3(urls, s3_credentials, max_workers=4, errors_json_
 def s3_transfer(datamule_bucket, s3_credentials, max_workers=4, errors_json_filename='s3_transfer_errors.json', retry_errors=3,
                 force_daily=True, cik=None, submission_type=None, filing_date=None, datamule_api_key=None,accession_number=None):
 
-    if datamule_bucket == 'filings_sgml_r2':
-
+    if datamule_bucket in ['filings_sgml_r2','sec_filings_sgml_r2']:
 
         if accession_number is not None:
             if any(param is not None for param in [cik, submission_type, filing_date]):

datamule/docs-rewrite/docs/datamule-python/examples/articles.md

@@ -6,4 +6,5 @@
 - [Extracting html tables from SEC filings](https://medium.com/@jgfriedman99/extracting-html-tables-from-sec-filings-7cb14bcd5945)
 
 ## GitHub
-- [Downloading every 10-K MDA + applying Loughran McDonald](https://github.com/john-friedman/Every-10-K-MDA-01-01-1993-12-21-2025.)
+- [Downloading every 10-K MDA + applying Loughran McDonald](https://github.com/john-friedman/Every-10-K-MDA-01-01-1993-12-21-2025.)
+- [Getting SEC filings minutes faster](https://github.com/john-friedman/The-fastest-way-to-get-SEC-filings)

datamule/docs-rewrite/docs/datamule-python/examples/products.md

@@ -0,0 +1,159 @@
+# Products
+
+Some features of datamule require an api_key. See [products](datamule.xyz/product).
+
+## SEC Filings SGML R2
+
+Downloads SEC filings from the SGML archive.
+```
+from datamule import Portfolio
+
+portfolio = Portfolio('meta')
+portfolio.download_submissions(ticker='META', submission_type='10-K', document_type='10-K', provider='datamule-sgml')
+```
+
+Transfers SEC filings to your S3 storage.
+```
+from datamule import Book
+import os
+
+book = Book()
+
+book.s3_transfer(datamule_bucket='sec_filings_sgml_r2',s3_credentials=s3_credentials,force_daily=True,filing_date=('2025-09-03','2025-09-11'),
+                 max_workers=128,errors_json_filename='s3_transfer_errors.json',retry_errors=3)
+```
+
+
+## SEC Filings TAR R2
+
+Downloads SEC filings from the TAR archive. Newer than the SGML archive, and generally 20x faster.
+```
+from datamule import Portfolio
+
+portfolio = Portfolio('meta')
+portfolio.download_submissions(ticker='META', submission_type='10-K', document_type='10-K', provider='datamule-tar')
+```
+
+Transfers SEC filings to your S3 storage. Not implemented yet.
+
+```
+from datamule import Book
+import os
+
+book = Book()
+
+book.s3_transfer(datamule_bucket='sec_filings_tar_r2',s3_credentials=s3_credentials,force_daily=True,filing_date=('2025-09-03','2025-09-11'),
+                 max_workers=128,errors_json_filename='s3_transfer_errors.json',retry_errors=3)
+```
+
+## SEC Filings Lookup MySQL
+
+Query SEC Filing metadata.
+```
+from datamule import Sheet
+
+sheet = Sheet('lookup')
+sheet.get_table('sec-filings-lookup',
+    cik=320193,
+    submissionType=['10-K', '10-Q'],
+    filingDate=('2024-01-01', '2024-12-31'),
+    containsXBRL=True,
+    returnCols=['accessionNumber', 'cik', 'submissionType', 'filingDate', 'detectedTime'])
+```
+
+## SEC Filings Websocket
+
+Get notified of new SEC filings in real time.
+```
+from datamule import Portfolio
+
+portfolio = Portfolio('newfilings')
+
+def data_callback(data):
+    for item in data:
+        print(item)
+
+stream_submissions(data_callback=data_callback)
+```
+
+## SEC Filings Lookup S3
+
+Not yet implemented.
+
+## SEC Proxy Voting Records MySQL
+
+Query proxy voting records.
+```
+from datamule import Sheet
+
+sheet = Sheet('proxy')
+results = sheet.get_table('proxy-voting-records',
+    cusip='037833100',
+    meetingDate=('2024-01-01', '2024-12-31'),
+    howVoted='For')
+print(results)
+```
+
+## SEC Proxy Voting Records S3
+
+Not yet implemented.
+
+## SEC Institutional Holdings MySQL
+```
+from datamule import Sheet
+
+sheet = Sheet('sheet')
+results = sheet.get_table('institutional-holdings',
+    cusip='88160R101',
+    sharesOrPrincipalAmount=('14000','14300')
+    )
+print(results)
+```
+
+## SEC Institutional Holdings S3
+
+Not yet implemented.
+
+## SEC Insider Transactions MySQL
+```
+from datamule import Sheet
+
+sheet = Sheet('sheet')
+results = sheet.get_table('insider-transactions',
+    table='signature',
+    signatureDate='2004-01-08')
+
+print(results)
+```
+
+## SEC Insider Transactions S3
+
+Not yet implemented.
+
+## SEC XBRL S3
+
+Not yet implemented.
+
+## Simple XBRL S3
+
+Not yet implemented.
+
+## Fundamentals S3
+
+Not yet implemented.
+
+## Simple XBRL MySQL
+
+```
+from datamule import Sheet
+
+sheet = Sheet('sheet')
+results = sheet.get_table('simple-xbrl',
+    accessionNumber=95017022000796)
+
+print(results)
+```
+
+## Fundamentals MySQL
+
+Not yet implemented.

datamule/docs-rewrite/mkdocs.yml

@@ -8,6 +8,7 @@ nav:
       - Overview: datamule-python/index.md
       - Examples: 
           - Quickstart: datamule-python/examples/quickstart.md
+          - Products: datamule-python/examples/products.md
           - Articles: datamule-python/examples/articles.md
           - Tesla Risk Factor Language Score: datamule-python/examples/tesla_risk_factor_language_score.md
           - Meta Risk Factor Semantic Drift:  datamule-python/examples/meta_risk_factor_semantic_drift.md

datamule/setup.py

@@ -32,7 +32,7 @@
 setup(
     name="datamule",
     author="John Friedman",
-    version="3.0.4",
+    version="3.0.5",
     description="Work with SEC submissions at scale.",
     packages=find_packages(include=['datamule', 'datamule.*']),
     url="https://github.com/john-friedman/datamule-python",