Repository files navigation

Essentials ➔      
Health ➔             
Quality ➔            
Distribution ➔   
Community ➔    

sec-ai is an open-source project designed to provide a comprehensive toolset for analyzing and interpreting data from SEC filings. Utilizing advanced AI technologies, this project aims to serve a wide range of users, from individual investors to researchers and regulatory bodies.

The project leveragesalphanome-ai/sec-parser for its data extraction needs, an essential component that simplifies the parsing of SEC EDGAR HTML documents into a structured and analyzable format.

• Explore theDemo
• Read theDocumentation
• Join theDiscussions to get help, propose ideas, or chat with the community
• Become part of ourDiscord community
• Report bugs inIssues
• Stay updated and contribute to our project's direction inAnnouncements andRoadmap
• Learn How toContribute

WarningThis project,sec-ai, is an independent, open-source initiative and has no affiliation, endorsement, or verification by the United States Securities and Exchange Commission (SEC). It utilizes public APIs and data provided by the SEC solely for research, informational, and educational objectives. This tool is not intended for financial advisement or as a substitute for professional investment advice or compliance with securities regulations. The creators and maintainers make no warranties, expressed or implied, about the accuracy, completeness, or reliability of the data and analyses presented. Use this software at your own risk. For accurate and comprehensive financial analysis, consult with qualified financial professionals and comply with all relevant legal requirements. The project maintainers and contributors are not liable for any financial or legal consequences arising from the use of this tool.

To get started, first install thesec-ai package:

pip install sec-ai

Next, please visit theDemo and explore the corresponding source code to understand how to utilize the package effectively.

To ensure your code remains functional even when we change the internal structure ofsec-ai, it's recommended to avoid deep imports. Here is an example of a deep import:

from sec_ai.something_package.internal_utils.core import SomeInternalClass

Here are the suggested ways to import modules fromsec-ai:

• import sec_ai as sp. This imports the main package assp. You can then access its functionalities usingsp. prefix.

• from sec_ai import SomeClass: This allows you to directly useSomeClass without any prefix.

• import sec_ai.something_package**: This imports thesomething_package submodule, and you can access its classes and functions usingsomething_package. prefix.

• from sec_ai.something_package import SomeClass: This imports a specific classSomeClass from thesomething_package submodule.

NoteThe main packagesec_ai contains only the most common functionalities. For specialized tasks, please use submodule or submodule-level imports.

For information about setting up the development environment, coding standards, and contribution workflows, please refer to ourCONTRIBUTING.md guide.

This project is licensed under the MIT License - see theLICENSE file for details.