datamule 1.1.1__py3-none-any.whl → 1.1.5__py3-none-any.whl

datamule/__init__.py

@@ -3,6 +3,8 @@ from .portfolio import Portfolio
 from .document import Document
 from .helper import _load_package_csv, load_package_dataset
 from .config import Config
+from .sheet import Sheet
+from .index import Index
 
 
 # Keep the notebook environment setup
@@ -32,5 +34,7 @@ __all__ = [
     'Portfolio',
     'Submission',
     'Document',
-    'Config'
+    'Config',
+    'Sheet',
+    'Index',
 ]

datamule/index.py

@@ -0,0 +1,62 @@
+from pathlib import Path
+from .sec.submissions.textsearch import query
+from .helper import _process_cik_and_metadata_filters, load_package_dataset
+
+class Index:
+    def __init__(self, path=None):
+        self.path = Path(path) if path else None
+        
+    def search_submissions(
+        self,
+        text_query,
+        start_date=None,
+        end_date=None,
+        submission_type=None,
+        cik=None,
+        ticker=None,
+        requests_per_second=5.0,
+        quiet=True,
+        **kwargs
+    ):
+        """
+        Search SEC filings for the given text query.
+        
+        Args:
+            text_query (str): Text to search for in SEC filings.
+            start_date (str or date, optional): Start date for filing search.
+            end_date (str or date, optional): End date for filing search.
+            submission_type (str, optional): Type of SEC submission to search.
+            cik (str, int, or list, optional): CIK(s) to filter by.
+            ticker (str or list, optional): Ticker(s) to filter by.
+            requests_per_second (float, optional): Rate limit for SEC API requests.
+            quiet (bool, optional): Whether to suppress output.
+            **kwargs: Additional filters to apply.
+            
+        Returns:
+            dict: Search results from the query function.
+        """
+        # Process CIK and ticker filters if provided
+        if cik is not None or ticker is not None:
+            cik_list = _process_cik_and_metadata_filters(cik, ticker, **kwargs)
+            # Add CIK filter to the query if we have results
+            if cik_list:
+                # Implementation note: Update as needed - this assumes your query function
+                # can accept a cik parameter, otherwise you may need additional logic here
+                kwargs['cik'] = cik_list
+            
+        # Execute the search query
+        results = query(
+            f'{text_query}',
+            filing_date=(start_date, end_date),
+            requests_per_second=requests_per_second,
+            quiet=quiet,
+            submission_type=submission_type,
+            **kwargs
+        )
+        
+        # Save results to path if specified
+        if self.path:
+            self._save_results(results, text_query)
+            
+        return results
+    

datamule/{book/book.py → sheet.py}

@@ -1,8 +1,8 @@
 from pathlib import Path
-from ..helper import _process_cik_and_metadata_filters, load_package_dataset
-from ..sec.xbrl.downloadcompanyfacts import download_company_facts
+from .helper import _process_cik_and_metadata_filters, load_package_dataset
+from .sec.xbrl.downloadcompanyfacts import download_company_facts
 
-class Book:
+class Sheet:
     def __init__(self, path):
         self.path = Path(path)
 

{datamule-1.1.1.dist-info → datamule-1.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: datamule
-Version: 1.1.1
+Version: 1.1.5
 Summary: Making it easier to use SEC filings.
 Home-page: https://github.com/john-friedman/datamule-python
 Author: John Friedman

{datamule-1.1.1.dist-info → datamule-1.1.5.dist-info}/RECORD

@@ -1,11 +1,11 @@
-datamule/__init__.py,sha256=0npnB3i2F7YB7etG315oDiCd-eMo-A6MP5LX2gQclHY,914
+datamule/__init__.py,sha256=l6YlwT5EeRxPlCtO5Jd4I8l266rSRUJyfFe97cRtSCM,991
 datamule/config.py,sha256=Y--CVv7JcgrjJkMOSLrvm2S8B9ost6RMSkGviP-MKtg,883
 datamule/document.py,sha256=BC8jdVy9pMOA9ghIqV5N2XJidmVNThqbBohsuSAnVoY,10813
 datamule/helper.py,sha256=xgOVnea-lUlQ5I-U0vYUp0VeKPNZehNhqjJvegA3lYE,3342
+datamule/index.py,sha256=0txvbzPcvY1GsdxA-wGdLzAByxSeE_1VyyBp9mZEQRM,2292
 datamule/portfolio.py,sha256=JmZlTrom_g7FXKXxWp_CiQTyC7p6_cDP08G0kFUja48,6982
+datamule/sheet.py,sha256=WwumRdniClGU7W3AXVLOpCdMnepLC7KMrRpQlA6_NUY,1022
 datamule/submission.py,sha256=JsxYlEz1Ywu6eC32OS15p4p-p8qB6SWd_rXuf2p5UfY,1247
-datamule/book/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datamule/book/book.py,sha256=QWiowVNqb84o-JcVo0fpKumxnIbBge2ZeKwHxqkVMqw,1023
 datamule/mapping_dicts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 datamule/mapping_dicts/txt_mapping_dicts.py,sha256=DQPrGYbAPQxomRUtt4iiMGrwuF7BHc_LeFBQuYBzU9o,6311
 datamule/mapping_dicts/xml_mapping_dicts.py,sha256=Z22yDVwKYonUfM5foQP00dVDE8EHhhMKp0CLqVKV5OI,438
@@ -29,7 +29,7 @@ datamule/sec/xbrl/xbrlmonitor.py,sha256=TKFVfSyyUUfUgFQw4WxEVs4g8Nh-2C0tygNIRmTq
 datamule/seclibrary/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 datamule/seclibrary/downloader.py,sha256=Zb1TxsIz887tO3MJVP66siYVtNus89ti-g9oZ6VywrM,11500
 datamule/seclibrary/query.py,sha256=qGuursTERRbOGfoDcYcpo4oWkW3PCBW6x1Qf1Puiak4,7352
-datamule-1.1.1.dist-info/METADATA,sha256=VZQtm8MY--M1N08bbO90e6jS3893-g2V8hFCT_9PGrc,512
-datamule-1.1.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-datamule-1.1.1.dist-info/top_level.txt,sha256=iOfgmtSMFVyr7JGl_bYSTDry79JbmsG4p8zKq89ktKk,9
-datamule-1.1.1.dist-info/RECORD,,
+datamule-1.1.5.dist-info/METADATA,sha256=9Q8YzsBipVuGYN4eWmH49sF5oyouyZvVdJ6rncDa0VE,512
+datamule-1.1.5.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+datamule-1.1.5.dist-info/top_level.txt,sha256=iOfgmtSMFVyr7JGl_bYSTDry79JbmsG4p8zKq89ktKk,9
+datamule-1.1.5.dist-info/RECORD,,