https://github.com/alphanome-ai/sec-ai
A comprehensive open-source toolkit for AI-powered analysis and interpretation of SEC EDGAR filings, providing valuable insights for investors, fintech developers, and researchers.
https://github.com/alphanome-ai/sec-ai
10-k 10-q 8-k ai artificial-intelligence cik company-data egdar-api filings finance financial-data financial-filings fintech investing nlp sec sec-edgar sec-edgar-api
Last synced: 4 months ago
JSON representation
A comprehensive open-source toolkit for AI-powered analysis and interpretation of SEC EDGAR filings, providing valuable insights for investors, fintech developers, and researchers.
- Host: GitHub
- URL: https://github.com/alphanome-ai/sec-ai
- Owner: alphanome-ai
- License: mit
- Created: 2023-09-09T14:20:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-27T18:20:01.000Z (about 1 year ago)
- Last Synced: 2025-02-04T04:06:08.530Z (4 months ago)
- Topics: 10-k, 10-q, 8-k, ai, artificial-intelligence, cik, company-data, egdar-api, filings, finance, financial-data, financial-filings, fintech, investing, nlp, sec, sec-edgar, sec-edgar-api
- Language: Python
- Homepage: https://sec.alphanome.app
- Size: 297 KB
- Stars: 117
- Watchers: 12
- Forks: 25
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
> [!NOTE]
> This project is currently under active development and has not been officially released to the public yet. If you're interested in staying up-to-date with the latest progress and being notified when the project is ready for use, please show your support by starring ⭐️ this repository. By starring the repo, you'll be among the first to know about any updates, releases, or important announcements. Thank you for your interest and patience!
sec-ai
Essentials ➔
Health ➔
Quality ➔
Distribution ➔
Community ➔
A comprehensive open-source toolkit for AI-powered analysis and interpretation of SEC EDGAR filings, providing valuable insights for investors, fintech developers, and researchers.
# Overview
`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 leverages [`alphanome-ai/sec-parser`](https://github.com/alphanome-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 the [**Demo**](https://sec.alphanome.app)
- Read the [**Documentation**](https://sec-ai.rtfd.io)
- Join the [**Discussions**](https://github.com/orgs/alphanome-ai/discussions) to get help, propose ideas, or chat with the community
- Become part of our [**Discord**](https://discord.gg/2MC3uJhBxs) community
- Report bugs in [**Issues**](https://github.com/alphanome-ai/sec-ai/issues)
- Stay updated and contribute to our project's direction in [**Announcements**](https://github.com/orgs/alphanome-ai/discussions/categories/announcements) and [**Roadmap**](https://github.com/orgs/alphanome-ai/discussions/categories/roadmap-future-plans)
- Learn How to [**Contribute**](https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md)
# Disclaimer
> **Warning**
This 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.
# Getting Started
To get started, first install the `sec-ai` package:
```bash
pip install sec-ai
```
Next, please visit the Demo and explore the corresponding source code to understand how to utilize the package effectively.
# Best Practices
## How to Import Modules In Your Code
To ensure your code remains functional even when we change the internal structure of `sec-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 from `sec-ai`:
### Root Import (prefix)
- **`import sec_ai as sp`**. This imports the main package as `sp`. You can then access its functionalities using `sp.` prefix.
### Root Import (direct)
- **`from sec_ai import SomeClass`**: This allows you to directly use `SomeClass` without any prefix.
### Submodule Import (prefix)
- **`import sec_ai.something_package**`**: This imports the `something_package` submodule, and you can access its classes and functions using `something_package.` prefix.
### Submodule Import (direct)
- **`from sec_ai.something_package import SomeClass`**: This imports a specific class `SomeClass` from the `something_package` submodule.
> **Note**
The main package `sec_ai` contains only the most common functionalities. For specialized tasks, please use submodule or submodule-level imports.
# Contributing
For information about setting up the development environment, coding standards, and contribution workflows, please refer to our [CONTRIBUTING.md](https://github.com/alphanome-ai/sec-ai/blob/main/CONTRIBUTING.md) guide.
# License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/alphanome-ai/sec-ai/blob/main/LICENSE) file for details.