Skip to content
This repository was archived by the owner on Aug 30, 2025. It is now read-only.

SimpleEnvs-Python v2.0.0-beta.1 Pre-Release

Pre-release
Pre-release

Choose a tag to compare

View all tags
@vmintf vmintf released this 12 Jun 22:47
· 19 commits to main since this release
v2.0.0-beta.1
b9b73c2

SimpleEnvs v2.0.0-beta.1 🚀

Release Date: January 2025
Status: Pre-release Beta
Previous Version: v1.1.4

🎉 What's New in Beta 1

SimpleEnvs v2.0.0-beta.1 delivers significant performance improvements, enhanced security, and comprehensive testing while maintaining full backward compatibility. This release represents a mature evolution of the existing architecture with production-ready enhancements.

⚡ Performance Improvements

🚀 Optimized File Processing

  • Adaptive file reading strategy: Small files (<1MB) use synchronous reading, large files use optimized async processing
  • Batch security validation: Process entire file content at once instead of line-by-line validation
  • Reduced memory allocations: More efficient parsing with fewer temporary objects
  • Smart async handling: Better performance for large .env files

📊 Real-World Performance Gains

Based on internal benchmarks, typical improvements:

  • Small files (10-100 vars): 10-20% faster loading
  • Medium files (100-1K vars): 20-40% faster loading
  • Large files (1K+ vars): Up to 2-3x faster loading

Results may vary based on file size, content complexity, and system specifications.

🛡️ Security Enhancements

🔒 Enhanced Security Validation

  • Improved null byte detection: Complete file content scanning
  • Stricter path validation: Additional edge cases covered
  • Better encoding validation: Enhanced UTF-8 compliance checking
  • Optimized security checks: Faster validation without compromising security

🧪 Comprehensive Security Testing

New vulnerability test suite with 51 test cases covering:

# Run the security test suite
python vuln_test.py

Test Categories:

  • 🔒 Path Traversal Attacks (8 tests) - ../../../etc/passwd, URL encoding variants
  • 📏 File Size Exploits (4 tests) - Oversized files, empty files, binary files
  • ⚠️ Injection Attacks (7 tests) - Script injection, command injection, variable substitution
  • 📄 File Format Exploits (4 tests) - Malformed files, encoding attacks, long lines
  • 🚫 Access Control (6 tests) - Unloaded environment, invalid operations
  • 🔄 Type Conversion (5 tests) - Invalid conversions, overflow attempts
  • 🔍 Key Validation (4 tests) - Missing keys, invalid key formats
  • 🛡️ Security Protocols (3 tests) - Session handling, memory security
  • 🔐 Integrity Checks (3 tests) - File modification detection
  • ⚙️ Configuration (4 tests) - Invalid parameters, edge case handling
  • 🎯 Edge Cases (3 tests) - Unicode content, empty files, whitespace-only files

🔧 Internal Architecture Improvements

📦 Code Organization

  • Refactored internal utilities: Better separation of concerns
  • Improved error handling: More descriptive error messages with context
  • Enhanced memory management: Better cleanup and garbage collection integration
  • Streamlined async operations: Reduced overhead in async file operations

🧪 Enhanced Testing & Benchmarking

  • Comprehensive vulnerability testing: 51 security test cases
  • Improved benchmark suite: Now includes secure API performance testing
  • Better dependency management: Clear guidance for missing dependencies
  • Cross-platform testing: Enhanced Windows/macOS/Linux compatibility

🐛 Bug Fixes

🔒 Security Fixes

  • Fixed edge cases in path traversal detection: Better coverage of URL encoding variants
  • Improved symbolic link handling: Cross-platform compatibility improvements
  • Enhanced file type validation: More robust binary file detection
  • Strengthened null byte detection: Complete content scanning

⚡ Performance Fixes

  • Optimized async file reading: Reduced I/O overhead for large files
  • Fixed memory usage patterns: Better memory efficiency in parsing
  • Improved error handling performance: Faster exception processing
  • Enhanced cleanup routines: Better resource management

🔧 Compatibility Fixes

  • Python 3.13 compatibility: Updated dependencies and testing
  • Windows path handling: Improved cross-platform file path processing
  • UTF-8 encoding improvements: Better international character support
  • Documentation dependencies: Fixed Python 3.9+ compatibility issues

📚 Developer Experience

🧪 New Testing Tools

# Run comprehensive security tests
python vuln_test.py

# Run performance benchmarks with secure API
python benchmark.py --secure

# Quick benchmark comparison
python benchmark.py --quick

📊 Enhanced Error Messages

More descriptive error messages with:

  • Detailed context: What operation failed and why
  • Helpful suggestions: How to fix common issues
  • Security details: When security validations trigger (in development mode)

📦 Installation & Upgrade

Fresh Installation

pip install SimpleEnvs-Python==2.0.0b1

Upgrade from v1.x

pip install --upgrade SimpleEnvs-Python==2.0.0b1

With Development/Testing Tools

pip install 'SimpleEnvs-Python[benchmark]==2.0.0b1'

🔄 API Compatibility

✅ Fully Backward Compatible

All existing v1.x code continues to work without changes:

# v1.1.4 code works unchanged in v2.0.0-beta.1
from simpleenvs import load_dotenv, get_secure
load_dotenv()
secret = get_secure('API_KEY')  # Works exactly the same

🆕 No Breaking Changes

  • All public APIs remain unchanged
  • Same import structure
  • Same function signatures
  • Same behavior and return values

🎯 What's Different

  • Faster performance - Same API, better speed
  • Enhanced security - More robust validation
  • Better testing - Comprehensive test coverage
  • Improved reliability - Better error handling

🚨 Beta Release Status

✅ Ready for Most Use Cases:

  • Development and staging environments
  • Production systems with standard requirements
  • Performance-critical applications (significant speed improvements)
  • Security-conscious applications (enhanced protection)

⚠️ Consider Carefully for:

  • Mission-critical systems requiring maximum stability
  • Environments with zero-tolerance change policies
  • Systems requiring extensive internal approval processes

🧪 Testing Checklist:

# 1. Verify basic functionality
python -c "import simpleenvs; simpleenvs.load_dotenv(); print('✅ Basic test passed')"

# 2. Run security tests  
python vuln_test.py

# 3. Benchmark performance
python benchmark.py --quick

# 4. Test your specific use case
# Run your application with the beta version

🤝 Feedback & Support

🐛 Bug Reports

💡 Feature Feedback

🔒 Security Issues

  • Private reporting: vmintf@gmail.com
  • Please report security concerns privately first

📊 Performance Reports

  • Share your benchmark results
  • Report any performance regressions
  • Help us optimize for real-world usage

📈 What's Next

v2.0.0-beta.2 (Target: February 2025)

  • Community feedback integration
  • Performance optimization based on real-world usage
  • Additional security hardening
  • Enhanced error messages and debugging

v2.0.0-rc.1 (Target: March 2025)

  • Feature freeze and stabilization
  • Comprehensive documentation updates
  • Production readiness validation
  • Final compatibility testing

v2.0.0 Stable (Target: Q1 2025)

  • Production-ready release
  • Long-term support commitment
  • Complete performance documentation
  • Enterprise deployment guides

🙏 Thanks

Special thanks to:

  • Early beta testers and feedback providers
  • Security researchers helping with vulnerability testing
  • Contributors to performance optimization efforts
  • The Python community for continued support

🚀 Try the Beta Today

pip install SimpleEnvs-Python==2.0.0b1

Same API, Better Performance:

# Your existing code works faster now!
from simpleenvs import load_dotenv, load_dotenv_secure
load_dotenv()  # ← Now with optimized performance
load_dotenv_secure()  # ← Enhanced security validation

⚠️ Beta Notice: This is a pre-release version with significant improvements. While thoroughly tested and backward compatible, we recommend testing in your specific environment before production deployment.

🚀 Performance: Measurable improvements across all file sizes with adaptive processing strategies.

🛡️ Security: Comprehensive protection with 51 security tests covering all major attack vectors.

🔧 Compatibility: 100% backward compatible - your existing code works unchanged and faster.

Made with ❤️ for the Python community

SimpleEnvs v2.0.0-beta.1 - Faster, Safer, Still Simple 🎯
Full Changelog: v1.1.4...v2.0.0-beta.1

Assets 4
Loading