spluspy 2.0.1__tar.gz → 2.0.3__tar.gz

spluspy-2.0.3/CHANGELOG.md

@@ -0,0 +1,132 @@
+# Changelog
+
+All notable changes to SplusPy will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/),
+and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [3.0.0] - 2026-07-10
+
+### Added
+
+#### Security
+- Removed insecure AES-ECB fallback for IGE encryption — PyCryptodome is now required
+- Removed hardcoded API credentials — `api_id` and `api_hash` must be provided by user
+
+#### Core
+- Complete Diffie-Hellman authorization key exchange (was previously a stub)
+- Full MTProto encrypted message handling with proper key derivation
+
+#### Storage Backends
+- `RedisStorage` — high-performance Redis backend with TTL, hash operations, and counters
+- `PostgresStorage` — production PostgreSQL backend with JSONB, indexes, and connection pooling
+- `get_storage()` factory function for creating backends by name
+
+#### FSM Enhancements
+- Decorator-based state routing: `@sm.state(Form.name)`
+- `on_enter` / `on_leave` hooks for state transitions
+- Fallback handler for unmatched states
+- `FSMContext.get()` / `FSMContext.set()` for single key access
+- `FSMContext.finish()` alias for reset
+- `StateTransition` class for conditional transitions
+
+#### Rate Limiting
+- `RateLimiter` with token bucket algorithm
+- `RateLimitMiddleware` for automatic flood wait handling
+- `FloodWait` and `FloodWaitError` exception types
+- Per-method rate limiting with configurable thresholds
+
+#### File Transfer
+- `ProgressTracker` and `TransferProgress` for upload/download progress
+- `stream_upload()` and `stream_download()` with chunked transfer
+- `parallel_download()` for concurrent media downloads
+- `format_size()` utility for human-readable file sizes
+
+#### Event System
+- `HandlerPriority` enum (FIRST, HIGH, NORMAL, LOW, LAST)
+- Handler priority ordering — lower values run first
+- `Event.stop_propagation()` to prevent subsequent handlers from running
+- `ErrorEvent` for handler error reporting
+- `@bot.on_error()` decorator for global error handling
+- `ErrorHandlerBuilder` for filtering errors by exception type
+
+#### Performance
+- `LRUCache` with hit/miss statistics and TTL support
+- `EntityCache` for auto-caching users/chats with deduplication
+- `batch_send()`, `batch_delete()`, `batch_forward()`, `batch_get_messages()`
+- `batch_operation()` generic batch executor
+
+#### Packaging & CLI
+- CLI entry point: `spluspy run bot.py`, `spluspy session-info`, `spluspy version`, `spluspy validate`
+- Dockerfile for containerized bot deployment
+- Optional dependencies: `pip install spluspy[redis]`, `pip install spluspy[postgres]`
+
+#### Testing
+- Tests for storage backends
+- Tests for enhanced FSM
+- Tests for rate limiter
+
+### Changed
+- `SoroushAPI` no longer has hardcoded `api_id`/`api_hash` — credentials must come from user
+- `TelegramConfig.apply_defaults()` now raises `ValueError` if credentials are missing
+- `EventBuilder` accepts `priority` parameter
+- `Client.on_message()` accepts `priority` kwarg
+- Updated `pyproject.toml` with new optional dependencies and CLI entry point
+
+### Fixed
+- AES-ECB fallback was insecure and broke IGE mode
+- Auth key exchange was a stub that never performed real DH exchange
+- `_process_message` now properly parses encrypted MTProto containers
+
+---
+
+## [2.0.0] - 2024-01-01
+
+### Added
+
+- Complete rewrite from scratch with clean architecture
+- Async-first design with full type hints
+- Synchronous client wrapper (`spluspy.sync`)
+- Composable filter system (`filters.text & filters.private`)
+- FSM (Finite State Machine) for conversational bots
+- Plugin system with dynamic loading
+- Middleware system for pre/post processing
+- Task scheduler
+- Multiple storage backends (Memory, SQLite)
+- Professional logging system
+- Connection pool with auto-reconnect
+- LRU cache
+- 100+ examples
+- Full test suite with pytest
+- CI/CD with GitHub Actions
+
+### Changed
+
+- Complete API redesign inspired by Telethon/Pyrogram
+- Message objects now have methods (reply, edit, delete, etc.)
+- Event system uses builder pattern
+- Session system supports SQLite, Memory, and String sessions
+- Exception hierarchy with specific error types
+
+### Removed
+
+- Legacy Telethon-forked code
+- Monolithic architecture
+- Untyped code
+
+---
+
+## [1.0.1] - 2023-12-01
+
+### Fixed
+
+- Minor bug fixes
+
+---
+
+## [1.0.0] - 2023-11-01
+
+### Added
+
+- Initial release as a Telethon fork
+- Basic Soroush Plus support

spluspy-2.0.3/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing to SplusPy
+
+Thank you for your interest in contributing to SplusPy! This document provides guidelines and information for contributors.
+
+## Getting Started
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+   ```bash
+   git clone https://github.com/your-username/spluspy.git
+   cd spluspy
+   ```
+3. Create a virtual environment:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # Linux/Mac
+   # or
+   venv\Scripts\activate     # Windows
+   ```
+4. Install development dependencies:
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+## Development Workflow
+
+1. Create a feature branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+2. Make your changes
+3. Run the linter:
+   ```bash
+   ruff check spluspy/
+   ```
+4. Run the formatter:
+   ```bash
+   black spluspy/
+   ```
+5. Run type checker:
+   ```bash
+   mypy spluspy/
+   ```
+6. Run tests:
+   ```bash
+   pytest
+   ```
+7. Commit your changes with a clear message
+8. Push to your fork and create a pull request
+
+## Code Style
+
+- Follow PEP 8
+- Use type hints for all functions and methods
+- Write docstrings for public APIs
+- Keep functions focused and small
+- Use meaningful variable and function names
+
+## Testing
+
+- Write tests for new features
+- Ensure all tests pass before submitting a PR
+- Aim for high test coverage
+
+## Pull Request Guidelines
+
+- Provide a clear description of the changes
+- Reference any related issues
+- Include tests for new functionality
+- Update documentation if needed
+
+## Reporting Issues
+
+- Use the GitHub issue tracker
+- Include steps to reproduce the issue
+- Include your Python version and OS
+- Include error messages and stack traces
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

spluspy-2.0.3/Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy requirements first for Docker layer caching
+COPY pyproject.toml README.md ./
+COPY spluspy/ spluspy/
+
+# Install the package
+RUN pip install --no-cache-dir ".[all]"
+
+# Copy bot script if present
+COPY bot.py ./
+
+# Run the bot
+CMD ["python", "bot.py"]

spluspy-2.0.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ali Mirshekari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

spluspy-2.0.3/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include README.rst
+include pyproject.toml
+recursive-include spluspy *.py *.pyi
+recursive-include tests *.py
+recursive-include examples *.py