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
- Join the Discussions to get help, propose ideas, or chat with the community
- Become part of our Discord community
- Report bugs in Issues
- Stay updated and contribute to our project's direction in Announcements and Roadmap
- Learn How to Contribute
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
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 assp. You can then access its functionalities usingsp.prefix.
Root Import (direct)
from sec_ai import SomeClass: This allows you to directly useSomeClasswithout any prefix.
Submodule Import (prefix)
import sec_ai.something_package**: This imports thesomething_packagesubmodule, and you can access its classes and functions usingsomething_package.prefix.
Submodule Import (direct)
from sec_ai.something_package import SomeClass: This imports a specific classSomeClassfrom thesomething_packagesubmodule.
Note The main package
sec_aicontains 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.post24
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.7.0.post24.tar.gz | 6.1 kB | Without provenance | Details for sec_ai-0.7.0.post24.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sec_ai-0.7.0.post24-py3-none-any.whl | Python 3 | none | any | Details for sec_ai-0.7.0.post24-py3-none-any.whl |
Total release size: 11.7 kB
Release files / sec_ai-0.7.0.post24.tar.gz
| Download URL | sec_ai-0.7.0.post24.tar.gz |
|---|---|
| Size | 6.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24f1dcdaaf9e3ff29fcdad71d64c426ac926d384d4d67adff471b906cb0a41f1
|
|
BLAKE2b-256 checksum How to use checksums |
92e620bfe6b3e68fa8696ebb56b871fb3cc6dcdabb83583ce248958de056139c
|
| 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-1016-azure
|
Release files / sec_ai-0.7.0.post24-py3-none-any.whl
| Download URL | sec_ai-0.7.0.post24-py3-none-any.whl |
|---|---|
| Size | 5.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
23a763567f8d3c870698d1a209515b2c255f64cc31c71e9b95968d0dce1de486
|
|
BLAKE2b-256 checksum How to use checksums |
a1f1c1f83559ec23829dc91ac9d2f208bb034ae637bf01131dac7cc73393b8f4
|
| 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-1016-azure
|
Security for sec-ai 0.7.0.post24
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.