| Version | Supported |
|---|---|
| 1.0.x | ✅ |
| < 1.0 | ❌ |
Please do not report security vulnerabilities through public GitHub issues.
Instead, please report them responsibly via one of these channels:
- GitHub Security Advisories: Use the Report a vulnerability button on the Security tab.
- Email: Send details to [email protected] with the subject line
[SECURITY] edgar_analytics.
- Description of the vulnerability and its potential impact
- Steps to reproduce or a proof of concept
- Affected version(s)
- Any suggested fix (optional but appreciated)
- Acknowledgment within 48 hours of your report
- Status update within 7 days with an assessment and expected timeline
- Credit in the release notes (unless you prefer to remain anonymous)
We will work with you to understand and address the issue before any public disclosure.
This policy covers:
- The
edgar-analyticsPython package published on PyPI - The source code in this repository
- The GitHub Actions CI/CD pipeline configuration
- The SEC EDGAR API itself or data accuracy of SEC filings
- Third-party dependencies (please report those to their respective maintainers)
- The
edgartoolslibrary (report to edgartools)
- SEC Identity: The SEC requires a User-Agent identity when accessing EDGAR. Use the
--identityflag or set theEDGAR_IDENTITYenvironment variable. Never share credentials in bug reports or issues. - API Keys: Do not commit API keys, tokens, or credentials to the repository.
- Dependencies: Keep dependencies up to date (
pip install --upgrade edgar-analytics). - Log Files: The
edgar_analytics_debug.jsonllog file may contain ticker symbols and financial data from your analysis. Handle it according to your data sensitivity requirements.