We take the security of the Product Analytics Handbook seriously. If you discover a security vulnerability, please follow these steps:
- Open a public GitHub issue for security vulnerabilities
- Discuss the vulnerability in public forums or social media
- Exploit the vulnerability beyond what is necessary to demonstrate it
- Report privately: Email the maintainers or use GitHub's private vulnerability reporting feature
- Provide details: Include as much information as possible:
- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if you have one)
- Your contact information
- Initial Response: Within 48 hours of receiving your report
- Status Update: Within 7 days with an initial assessment
- Resolution: We aim to address critical vulnerabilities within 30 days
We appreciate responsible disclosure and will:
- Acknowledge your contribution in our security advisories (unless you prefer to remain anonymous)
- Keep you informed of the progress toward resolving the issue
- Credit you in release notes when the fix is published (with your permission)
| Version | Supported |
|---|---|
| Latest | β Yes |
| Older |
We recommend always using the latest version of the application.
When using the Product Analytics Handbook:
-
Keep Dependencies Updated
- Regularly update Python packages:
pip install -r requirements.txt --upgrade - Check for security updates:
pip list --outdated
- Regularly update Python packages:
-
Protect Sensitive Data
- Never commit API keys or credentials to the repository
- Use environment variables for sensitive configuration
- Use
.streamlit/secrets.tomlfor local secrets (already in.gitignore)
-
Data Upload Safety
- Be cautious when uploading sensitive data to the application
- Remember that uploaded data is processed locally in your browser/server
- Clear browser cache if you're concerned about data persistence
-
Environment Security
- Use virtual environments to isolate dependencies
- Review dependencies before installation
- Keep Python and system packages up to date
- This application processes data locally
- No data is sent to external servers (except when using specific APIs like FRED or yfinance)
- Users are responsible for ensuring compliance with their data protection requirements
- We use reputable, well-maintained packages
- Dependencies are specified in
requirements.txt - We recommend reviewing security advisories for:
- Streamlit
- Pandas
- NumPy
- Scikit-learn
- Other data science libraries
Some features use external APIs:
- FRED API: Economic data from Federal Reserve Economic Data
- yfinance: Financial data from Yahoo Finance
Users should:
- Review the terms of service for these APIs
- Use their own API keys when required
- Be aware of rate limits and usage policies
We will:
- Monitor dependencies for known vulnerabilities
- Update dependencies when security patches are released
- Announce security updates in release notes
- Use GitHub Security Advisories for critical issues
For security-related inquiries that are not vulnerabilities, please open a discussion on GitHub or contact the maintainers through the repository.
Thank you for helping keep Product Analytics Handbook and our users safe! π