datamule 1.1.1__tar.gz → 1.1.6__tar.gz

{datamule-1.1.1 → datamule-1.1.6}/PKG-INFO

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

{datamule-1.1.1 → datamule-1.1.6}/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-1.1.6/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-1.1.1 → datamule-1.1.6}/datamule/sec/submissions/monitor.py

@@ -5,7 +5,7 @@ from ..rss.monitor import start_monitor  # Import start_monitor directly
 import pytz
 
 
-async def _process_efts_hits(hits, collected_accession_numbers, data_callback=None):
+async def _process_efts_hits(hits, collected_accession_numbers, data_callback=None,rate_limiter=None):
     """Process EFTS hits, collect accession numbers, and call data callback."""
     processed_hits = []
     
@@ -36,7 +36,7 @@ async def _process_efts_hits(hits, collected_accession_numbers, data_callback=No
     
     # Call data callback if provided
     if data_callback and processed_hits:
-        await data_callback(processed_hits)
+        await data_callback(processed_hits, rate_limiter)
         
     return processed_hits
 
@@ -61,7 +61,7 @@ async def _master_monitor_impl(data_callback=None, poll_callback=None, submissio
     
     # Prepare a wrapper callback to collect accession numbers
     async def process_callback(hits):
-        await _process_efts_hits(hits, collected_accession_numbers, data_callback)
+         await _process_efts_hits(hits, collected_accession_numbers, data_callback, efts_query.limiter)
     
     # Create an EFTSQuery instance
     efts_query = EFTSQuery(requests_per_second=requests_per_second)

datamule-1.1.1/datamule/book/book.py → datamule-1.1.6/datamule/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 → datamule-1.1.6}/datamule.egg-info/PKG-INFO

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

{datamule-1.1.1 → datamule-1.1.6}/datamule.egg-info/SOURCES.txt

@@ -3,15 +3,15 @@ datamule/__init__.py
 datamule/config.py
 datamule/document.py
 datamule/helper.py
+datamule/index.py
 datamule/portfolio.py
+datamule/sheet.py
 datamule/submission.py
 datamule.egg-info/PKG-INFO
 datamule.egg-info/SOURCES.txt
 datamule.egg-info/dependency_links.txt
 datamule.egg-info/requires.txt
 datamule.egg-info/top_level.txt
-datamule/book/__init__.py
-datamule/book/book.py
 datamule/mapping_dicts/__init__.py
 datamule/mapping_dicts/txt_mapping_dicts.py
 datamule/mapping_dicts/xml_mapping_dicts.py

{datamule-1.1.1 → datamule-1.1.6}/setup.py

@@ -29,7 +29,7 @@ if not file_path.exists():
 setup(
     name="datamule",
     author="John Friedman",
-    version="1.1.1",
+    version="1.1.6",
     description="Making it easier to use SEC filings.",
     packages=find_packages(include=['datamule', 'datamule.*']),
     url="https://github.com/john-friedman/datamule-python",