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 ➔     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.

Getting Started

To get started, first install the sec-ai package:

pip install sec-ai

Warning We are currently finalizing a few key prerequisites for sec-ai within our sec-parser project, as detailed in our Roadmap.

Your anticipation for the launch of sec-ai is greatly appreciated. We are working diligently to ensure that sec-ai is ready to launch as soon as possible. To stay informed about our progress and to receive notifications when sec-ai is ready, please follow our Announcements page.

Get Involved: If you're excited about our project and would like to contribute, we warmly invite you to do so! Check out our sec-parser/CONTRIBUTING.md guide for details on how to get started.

Thank you for your interest and we look forward to sharing our progress with you soon.

For more examples and advanced usage, you can continue learning how to use sec-ai by referring to the User Guide, Developer Guide, and Documentation.

Best Practices

Importing modules

  1. Standard: import sec_ai as sai
  2. Package-Level: from sec_ai import SomeClass
  3. Submodule: from sec_ai import sub_module
  4. Submodule-Level: from sec_ai.sub_module import SomeClass

Note The root-level package sec_ai contains only the most common symbols. For more specialized functionalities, you should use submodule or submodule-level imports.

Warning To allow us to maintain backward compatibility with your code during internal structure refactoring for sec-ai, avoid deep or chained imports such as sec_ai.sub_module.internal_utils import SomeInternalClass.

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.6.0.post14

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.6.0.post14
File Size Uploaded Provenance Actions
sec_ai-0.6.0.post14.tar.gz 5.7 kB Without provenance Details for sec_ai-0.6.0.post14.tar.gz

Built distribution (wheel)

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

Total release size: 10.8 kB

Release files / sec_ai-0.6.0.post14.tar.gz

Download URL sec_ai-0.6.0.post14.tar.gz
Size 5.7 kB
Tags Source
SHA-256 checksum
How to use checksums
2f1eed70af4e76f09503c3fdfce553da2286ee2911b626b0287dfe9e8a62a86b
BLAKE2b-256 checksum
How to use checksums
f36a9855f1b3bb796a0916b6e9f176fe200d96b29ebb31e5201d432a9311adfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.5 Linux/6.2.0-1012-azure

Release files / sec_ai-0.6.0.post14-py3-none-any.whl

Download URL sec_ai-0.6.0.post14-py3-none-any.whl
Size 5.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f77a7fd5adac3cb50b623ee373a57774fcb74908b8d976fa38102ba4112e6d52
BLAKE2b-256 checksum
How to use checksums
e63781015e86dcd3f6998bf2f272e25d94678571de1cb783e404ce889f89bff7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.5 Linux/6.2.0-1012-azure

Security for sec-ai 0.6.0.post14

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