Skip to main content

 

sec-ai

Essentials ➔       Documentation Status Licence Project Type: Federation Experimental
Health ➔              GitHub Workflow Status: ci.yml GitHub Workflow Status: cd.yml Last Commit
Quality ➔             codecov Code Style: Black Ruff
Distribution ➔    PyPI version PyPI - Python Version PyPI downloads
Community ➔     Discord HitCount X (formerly Twitter) Follow GitHub stars

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 for its data extraction needs, an essential component that simplifies the parsing of SEC EDGAR HTML documents into a structured and analyzable format.

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:

pip install sec-ai

Warning We're thrilled to inform you that the sec-parser project is the final prerequisite for launching our eagerly anticipated feature, sec-ai. We're diligently working to ensure that it meets all the necessary standards and functionalities.

Stay Informed: For detailed information and updates specific to sec-parser and to be the first to know when sec-ai is launched, please follow our Announcements page.

Contribute to sec-parser: If you're as excited about sec-parser and the upcoming sec-ai feature as we are, we warmly invite you to get involved!

- Join our Discussions and connect with us on Discord.
- Please review our Contribution Guide for sec-parser.
- Explore the current Issues or propose new enhancements to the sec-parser.

Our targeted launch for sec-ai is approaching, and we're grateful for your continued anticipation and interest, which are invaluable to our endeavors.

Best Practices

How to Import Modules In Your Code

To ensure your code remains functional even when we update sec-ai, it's recommended to avoid complex imports. Don't use intricate import statements that go deep into the package, like this:

from sec_ai.some_package.internal_utils import SomeInternalClass

Here are the suggested ways to import modules from sec-ai:

Basic Import

  • Standard Way: Use import sec_ai as sai
    This imports the main package as sai. You can then access its functionalities using sai. prefix.

Specific Import

  • Package-Level Import: Use from sec_ai import SomeClass
    This allows you to directly use SomeClass without any prefix.

Submodule Import

  • Submodule: Use from sec_ai import some_package
    This imports the some_package submodule, and you can access its classes and functions using some_package. prefix.

More Specific Submodule Import

  • Submodule-Level: Use from sec_ai.some_package import SomeClass
    This imports a specific class SomeClass from the some_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 guide.

License

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

Metadata

Release files for sec-ai 0.7.0.post22

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sec-ai 0.7.0.post22
File Size Uploaded Provenance Actions
sec_ai-0.7.0.post22.tar.gz 6.4 kB Without provenance Details for sec_ai-0.7.0.post22.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sec-ai 0.7.0.post22
File Interpreter ABI Platform Actions
sec_ai-0.7.0.post22-py3-none-any.whl Python 3 none any Details for sec_ai-0.7.0.post22-py3-none-any.whl

Total release size: 12.4 kB

Release files / sec_ai-0.7.0.post22.tar.gz

Download URL sec_ai-0.7.0.post22.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
aa171bc04c873b09a6ba3cc82e936d9843faccc2ecf74e9d8525ed5d78c71218
BLAKE2b-256 checksum
How to use checksums
959f8442d5df656d20f35d5e906c6c6be11adfb0b5756208df17f961a5b5094f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.6 Linux/6.2.0-1015-azure

Release files / sec_ai-0.7.0.post22-py3-none-any.whl

Download URL sec_ai-0.7.0.post22-py3-none-any.whl
Size 5.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ba35238ede2a07488a8e1b0be0f576a434d2d1696d90dce657d1ac995101596d
BLAKE2b-256 checksum
How to use checksums
afbef5fbbf33701a80ba0d564e54e97c4f0e72f3751f934a3a4c2f802fb18b34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.6 Linux/6.2.0-1015-azure

Security for sec-ai 0.7.0.post22

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page