datamule 0.381__py3-none-any.whl → 1.0.2__py3-none-any.whl

datamule-0.381.dist-info/METADATA

@@ -1,132 +0,0 @@
-Metadata-Version: 2.1
-Name: datamule
-Version: 0.381
-Summary: Making it easier to use SEC filings.
-Home-page: https://github.com/john-friedman/datamule-python
-Author: John Friedman
-License: MIT License
-        
-        Copyright (c) 2024 John Friedman
-        
-        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.
-        
-Description-Content-Type: text/markdown
-Requires-Dist: aiohttp
-Requires-Dist: aiolimiter
-Requires-Dist: tqdm
-Requires-Dist: requests
-Requires-Dist: nest-asyncio
-Requires-Dist: aiofiles
-Requires-Dist: polars
-Requires-Dist: setuptools
-Requires-Dist: selectolax
-Provides-Extra: all
-Requires-Dist: pandas ; extra == 'all'
-Requires-Dist: lxml ; extra == 'all'
-Requires-Dist: openai ; extra == 'all'
-Requires-Dist: google-generativeai ; extra == 'all'
-Requires-Dist: psutil ; extra == 'all'
-Requires-Dist: flask ; extra == 'all'
-Provides-Extra: dataset_builder
-Requires-Dist: pandas ; extra == 'dataset_builder'
-Requires-Dist: google-generativeai ; extra == 'dataset_builder'
-Requires-Dist: psutil ; extra == 'dataset_builder'
-Provides-Extra: filing_viewer
-Requires-Dist: lxml ; extra == 'filing_viewer'
-Provides-Extra: mulebot
-Requires-Dist: openai ; extra == 'mulebot'
-Provides-Extra: mulebot_server
-Requires-Dist: flask ; extra == 'mulebot_server'
-
-# datamule
-
-[![Downloads](https://static.pepy.tech/badge/datamule)](https://pepy.tech/project/datamule)
-[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fjohn-friedman%2Fdatamule-python&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
-![GitHub](https://img.shields.io/github/stars/john-friedman/datamule-python)
-
-A Python package for working with SEC filings at scale. Includes [Mulebot](https://chat.datamule.xyz/), an open-source chatbot for SEC data with no storage requirements. 📚 [Full Documentation](https://john-friedman.github.io/datamule-python/) | 🌐 [Website](https://datamule.xyz/)
-
-Articles:
-- [Article: Creating Structured Datasets from SEC filings](https://medium.com/@jgfriedman99/how-to-create-alternative-datasets-using-datamule-d3a0192da8f6)
-- [Article: Deploy a Financial Chatbot in 5 Minutes](https://medium.com/@jgfriedman99/how-to-deploy-a-financial-chatbot-in-5-minutes-ef5eec973d4c)
-
-## Key Features
-
-- 📥 [Download SEC filings quickly and efficiently](https://john-friedman.github.io/datamule-python/usage/downloader.html#)
-- 🔍 [Monitor EDGAR for new filings in real-time](https://john-friedman.github.io/datamule-python/usage/downloader.html#monitoring-new-filings)
-- 📊 [Parse filings at scale](https://john-friedman.github.io/datamule-python/usage/parsing.html#filing-parser)
-- 💾 [Access comprehensive datasets (10-Ks, SIC codes, etc.)](https://john-friedman.github.io/datamule-python/datasets.html)
-- 🤖 [Interact with SEC data using MuleBot](https://john-friedman.github.io/datamule-python/usage/mulebot.html)
-
-## Quick Start
-
-```bash
-# Basic installation
-pip install datamule
-
-# Install with all features
-pip install datamule[all]
-```
-
-```python
-import datamule as dm
-
-# Download filings
-downloader = dm.Downloader()
-downloader.download(form='10-K', ticker='AAPL')
-
-# Download filing attachments such as information tables
-downloader.download(form='13F-HR',file_types=['INFORMATION TABLE'],date=('2024-09-14','2024-09-16'))
-
-# Download every 10Q from 2023. Should take 2 minutes
-downloader.download_dataset(dataset='10q_2023')
-```
-
-## Available Extras
-
-- `filing_viewer`: Filing viewer module
-- `mulebot`: SEC data interaction chatbot
-- `mulebot_server`: Flask server for MuleBot
-- `all`: All available features
-
-## Resources
-
-- 📊 [SEC Filing Glossary](https://datamule.xyz/sec_glossary)
-- 📈 [XBRL Fact Glossary](https://datamule.xyz/xbrl_fact_glossary)
-- 🤖 [Try MuleBot](https://chat.datamule.xyz/)
-
-## Datasets
-
-Access comprehensive SEC datasets including:
-- Historical FTD data (since 2004)
-- 10-K and 10-Q filings (since 2001)
-- 13F-HR Information Tables (since 2013)
-- MD&A collection (100,000+ since 2001, requires free API key)
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-## License
-
-[MIT License](LICENSE)
-
----
-
-For detailed usage examples, API reference, and advanced features, please visit our [documentation](https://john-friedman.github.io/datamule-python/).

datamule-0.381.dist-info/RECORD

@@ -1,61 +0,0 @@
-datamule/__init__.py,sha256=fdl2hIu4qGb1_3ZR0FNV5FoVAcNTAex-Uzw7Ahd1Ub4,2385
-datamule/datamule_api.py,sha256=j78aWWjUgDRiozZEvdD36nUYy7VQL6zjEko3qndjvCc,755
-datamule/global_vars.py,sha256=PnaGwbq7hxahIen1WI9IMzwY9cv1ssxckyR13OFm5bA,14449
-datamule/helper.py,sha256=yHSryxKBm0Dt7RIUGnZx3lsTluomSl46cr-anOgcIxg,5474
-datamule/sec_filing.py,sha256=RIjxks4DuAJcxwGJBpXDVj0LYRVvwXcpDYG973DaZhw,5318
-datamule/sec_search.py,sha256=KteN1n7y9auOryonJt17_um3QfEZkWmf7qN71TbscEY,826
-datamule/data/company_former_names.csv,sha256=zTBWdV12_JE3aROFOMrFNTHLPW_M4TDruxtl15-XfA0,714528
-datamule/data/company_metadata.csv,sha256=X7uSIwConqC0sz-moIhXIISg6FI7GLGSlvAfDDf8Sd0,3078648
-datamule/data/company_tickers.csv,sha256=OtladoD7ZfxrRMmZa5hmZlG3YQdqGOxMXIlhk6s0znA,417504
-datamule/data/filing_types.csv,sha256=CAkckqgpSxihMaXnc5IkNS-5NE6OYJgsRoYPDCJpyuk,5433
-datamule/data/ftd_locations.csv,sha256=2ykZ_QCV86Sx1I0IkIOmxxTtlSiJbhdPqrYx7nfuBmA,45288
-datamule/data/sec-glossary.csv,sha256=TPjTBVM3kyFd8xHsmihykepvKbuLAAthOfEDjh_H-Kk,251937
-datamule/data/xbrl_descriptions.csv,sha256=Hg9BOo9zSjR7Khvx0pikILcbmDK_A404dmQtWuESK4s,2631548
-datamule/dataset_builder/_init.py,sha256=ogmcPxCP6RB3ofpmGlBhXTQHZ_Mksu_WQY3b7jM0k6Y,43
-datamule/dataset_builder/dataset_builder.py,sha256=7bo7HP5vfNg1ZrSEH3p8Pc45UswuTkGuk46dF3o-p_k,10036
-datamule/downloader/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datamule/downloader/dropbox_downloader.py,sha256=hMTz712smo_JeNsDMaI3Vu9lYcYq4F6eNclvFeKrQAU,8202
-datamule/downloader/ftd.py,sha256=vta7ejot1KRI-ntQ2YZTXUMxXiwMEH9GZtwvzeyKzJU,6583
-datamule/downloader/information_table_13f.py,sha256=IwrCOpali7-Qqcmh16-k6Tg14vE1c3rPQ2iSPJq2OFk,9242
-datamule/downloader/sec_downloader.py,sha256=olGZE7-tpGHwGzLluNrDstvDO03OfvwiB1fKehCsXw8,30462
-datamule/filing_viewer/__init__.py,sha256=9yUjDNmd-_HJkGASq7IT69UBoev14IvCLbwFLjP6G3s,69
-datamule/filing_viewer/filing_viewer.py,sha256=rGRI9yAT3V4zE3BHKNso49MLzR2EgPA5ZNTZEOLi7yk,8522
-datamule/mulebot/__init__.py,sha256=GM5cTnijSSLO9GXFdsCuz5B1iwGUcxDbpoBQ6zw1Odo,30
-datamule/mulebot/helper.py,sha256=Hzzr2HReHpFe2GfpVU79EXvQFx3oL9UiwkJp--Sd1N4,1114
-datamule/mulebot/mulebot.py,sha256=wN0Tv5fvarXgk1LRCcgPhj8Xgd8uYFn-cMucxTxRsEo,5966
-datamule/mulebot/search.py,sha256=kuuPaMp2z9U8GY2LCulmqC8VFlYOLXf3bfLaBETObb0,2124
-datamule/mulebot/tools.py,sha256=6giVRck3dgHmX0w9IvTe5I2FAiaBGTYuvwH6futDaes,3022
-datamule/mulebot/mulebot_server/__init__.py,sha256=x1QhXys7BWxi2g9_ZHUYA6S6rL3VL2718x4rYtGaaIg,33
-datamule/mulebot/mulebot_server/server.py,sha256=G9Pd0mGNWU04pHc73D8rIn7PWGjoApd3BBWn3CwXkHM,3633
-datamule/mulebot/mulebot_server/static/css/minimalist.css,sha256=0oGf8p1cJFLjPUfx95rH6tbtbeUFUbZ1DhmzYkak6ro,3147
-datamule/mulebot/mulebot_server/static/scripts/artifacts.js,sha256=jvcvjRioXwKx4dJwyIrVnD0sEpdHR13DrVwfWzgcXag,2325
-datamule/mulebot/mulebot_server/static/scripts/chat.js,sha256=i9HIPcOLTuhOwT6AIxLI5FLQhMHIaDfaFSBSJCpEIlg,3199
-datamule/mulebot/mulebot_server/static/scripts/filingArtifacts.js,sha256=yVDthXjmZ9cRSeu_9mRPf8JWAWeuwvRi5Hd9o_3Puek,2089
-datamule/mulebot/mulebot_server/static/scripts/listArtifacts.js,sha256=kZeRl6ztFnOd46xNbUXIvEKYbgFcxT4ABDDmataEVpg,443
-datamule/mulebot/mulebot_server/static/scripts/main.js,sha256=GXWqjzFozNhWdc2jgh0mplIGM_FUG4LR-A8DGN5yTgg,1938
-datamule/mulebot/mulebot_server/static/scripts/prefilledPrompt.js,sha256=qRbhF3MmwmIQAV-QYxw-SOMFuFSF2tH5oBen5OYX5hQ,1119
-datamule/mulebot/mulebot_server/static/scripts/suggestions.js,sha256=vqFoHG0z0YIhmA1w2X60biKRSWlkYkXcVuAmwbvsCaE,1841
-datamule/mulebot/mulebot_server/static/scripts/tableArtifacts.js,sha256=jelibkbM9YlrlU7_-kaVisMh8OjIKWZpJQ9_FiHV4OQ,4565
-datamule/mulebot/mulebot_server/static/scripts/utils.js,sha256=pOzsJ6bGxakN6G5qUvmkZd34u0GRHFxvH3pKpUmnhMc,1282
-datamule/mulebot/mulebot_server/templates/chat-minimalist.html,sha256=mm-LomSoNcJImsFwLpFWt3kIFnxUzIPmUZ1Dt5BFN0s,7065
-datamule/parser/__init__.py,sha256=cBUylBtwsQROlCT26LTIcHrZREA8cytkWVGLdkDaZdY,43
-datamule/parser/basic_10k_parser.py,sha256=z1ZP8L8ZOfcpo6S3jmS3aQvefOurqS4u6oy9bh1UBHA,3137
-datamule/parser/basic_10q_parser.py,sha256=kZWGljvC0TYLh4eWl4JQyl4XYto8X6NN6YIW-_iffqA,2695
-datamule/parser/basic_13d_parser.py,sha256=1nxBi9KFJuzw7CeEXpJFDzYVUd6rj4eCYiKHsGjK2b4,1585
-datamule/parser/basic_13g_parser.py,sha256=H9_MuOgkYVTIGwhj9w_WIpfMDdgakE_qs0Y3fvaUj_E,1691
-datamule/parser/basic_8k_parser.py,sha256=fzf8q9LOpBMHGWw-sfqUq3pyFZBlw47nLJBQWPhtGGg,2549
-datamule/parser/company_concepts_parser.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datamule/parser/form_d_parser.py,sha256=NTAfC8W3i2y7aIofXoLlAbY-4F6QVELYfIPIrVErjVY,2105
-datamule/parser/generalized_item_parser.py,sha256=M2bmYivSXe0POyBtDlPMykyyCgG8n1egRpJuZtZTR_g,2694
-datamule/parser/generalized_xml_parser.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-datamule/parser/helper.py,sha256=gIDmm5FUhWBLc9LnJ1EJL42RjfrYbrqq6QvTNZVuAJU,2628
-datamule/parser/information_table_parser_13fhr.py,sha256=vCIEqxOoBf1lnOKTJAifnPEXihtSPZcwRFW8yWhEZLc,1808
-datamule/parser/insider_trading_parser.py,sha256=IrH5a3qikPjC1GFoYzapfYW_CArbK0FkbJLbWSfsYNQ,7264
-datamule/parser/mappings.py,sha256=dq6EjaxxDHjH-sg62adRwJOf1v736QiLwXavOHs2vy8,5380
-datamule/parser/n_port_p_parser.py,sha256=T6GliMm-TETPsFM-hDKt1BkMnSenvDeThj50RsIip50,2293
-datamule/parser/sec_parser.py,sha256=0f-hPNcL_LsjJchJ5TgYlS76IFKNQ8ZetOzAMTTeWvw,3061
-datamule/parser/sgml_parser.py,sha256=vw0kLDmH_prokBuKfZ9PkFmp-oV82ZzFpEEBJM1RrFI,6575
-datamule-0.381.dist-info/METADATA,sha256=hOEoOOqzP3QlWzONwUj4yr6RG6sQnMfjThcktgBG3W8,5597
-datamule-0.381.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-datamule-0.381.dist-info/top_level.txt,sha256=iOfgmtSMFVyr7JGl_bYSTDry79JbmsG4p8zKq89ktKk,9
-datamule-0.381.dist-info/RECORD,,