sec-ai
Essentials ➔
Health ➔
Quality ➔
Distribution ➔
Community ➔
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.
- Explore the Demo
- Read the Documentation
- Ask questions in Discussions
- Report bugs in Issues
- Check out the Roadmap
Installation
Open a terminal and run the following command to install sec-ai:
pip install sec-ai
Usage
import sec_ai as sa
# TODO: Examples are coming soon!
For more examples and advanced usage, you can continue learning how to use sec-ai by referring to the Quickstart User Guide.
Contributing
Contributing to sec-ai is a rewarding way to improve this open-source project. Whether you are a user interested in expanding your knowledge or a developer who wants to dive deeper into the codebase, we have comprehensive guides to get you started.
-
User Guide: If you are new to
sec-aiand would like to get started, please refer to the Quickstart User Guide. -
Developer Guide: For those interested in contributing to
sec-ai, the Comprehensive Developer Guide provides an in-depth walkthrough of the codebase and offers examples to help you contribute effectively.
Both guides are interactive and allow you to engage with the code and concepts as you learn. You can run and modify all the code examples for yourself by cloning the repository and running the respective notebooks in a Jupyter environment.
Alternatively, you can run the notebooks directly in your browser using Google Colab.
Note Before contributing, we highly recommend familiarizing yourself with these guides. They will help you understand the structure and style of our codebase, enabling you to make effective contributions.
Best Practices
Importing modules
- Standard:
import sec_ai as sa - Package-Level:
from sec_ai import SomeClass - Submodule:
from sec_ai import sub_module - Submodule-Level:
from sec_ai.sub_module import SomeClass
Note The root-level package
sec_aicontains 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 assec_ai.sub_module.internal_utils import SomeInternalClass.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Metadata
Release files for sec-ai 0.5.1.post11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sec_ai-0.5.1.post11.tar.gz | 5.5 kB | Without provenance | Details for sec_ai-0.5.1.post11.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sec_ai-0.5.1.post11-py3-none-any.whl | Python 3 | none | any | Details for sec_ai-0.5.1.post11-py3-none-any.whl |
Total release size: 10.7 kB
Release files / sec_ai-0.5.1.post11.tar.gz
| Download URL | sec_ai-0.5.1.post11.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
613585277578f41dc59efe81d385ce7fb5f468ab1b7c837310c568f6ab8af366
|
|
BLAKE2b-256 checksum How to use checksums |
b66c2ca355cfaae6c825684e6d8b9eaaafbeed1197295608846cf88909cfc445
|
| 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.5.1.post11-py3-none-any.whl
| Download URL | sec_ai-0.5.1.post11-py3-none-any.whl |
|---|---|
| Size | 5.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d28c56055218412808152b499d1ddf1ecc49c68addaa0a73c60a1dcf26d20875
|
|
BLAKE2b-256 checksum How to use checksums |
f7faa5825c703fa26a56e6f698ae9323b93b8df020e8286c549f8f0fb656e4d6
|
| 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.5.1.post11
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.