Release version 1.0.1: Improved testing, documentation, and type checking

Author: muditbhargava66

.gitignore

@@ -181,4 +181,6 @@ results/
 
 # Sensitive or personal files
 config.ini
-secrets.yaml
+secrets.yaml
+
+.ruff_cache/

CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to the Advanced Image Sensor Interface project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.1] - 2024-03-04
+
+### Fixed
+- Fixed MIPI driver performance optimization test to be deterministic
+- Fixed signal processing noise reduction implementation to properly reduce noise
+- Fixed power management validation for input configuration parameters
+- Fixed handling of zero values in dynamic range calculation
+- Fixed voltage stability issues in power management system
+
+### Added
+- Comprehensive test suite with 67+ unit tests across all components
+- New testing guide documentation with best practices
+- Type checking with both MyPy and Pyright
+- Clean separation of test fixtures for better test stability
+- Improved error handling across all components
+
+### Changed
+- Updated dependencies to address security vulnerabilities
+- Improved code quality and test reliability
+- Enhanced documentation with detailed API references
+- Optimized performance testing approach for reliability
+- Restructured signal processing pipeline for better noise reduction
+
+## [1.0.0] - 2024-01-15
+
+### Added
+- Initial release of Advanced Image Sensor Interface
+- MIPI Driver with support for high-speed data transfer
+- Signal Processing Pipeline with noise reduction and color correction
+- Power Management System with dual-rail support
+- Performance Metrics utilities and benchmarking tools
+- Comprehensive documentation including API docs, design specs, and performance analysis
+
+[1.0.1]: https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface/releases/tag/v1.0.0

CONTRIBUTING.md

@@ -0,0 +1,163 @@
+# Contributing to Advanced Image Sensor Interface
+
+Thank you for your interest in contributing to the Advanced Image Sensor Interface project! This document provides guidelines and instructions for contributing to the project.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Workflow](#development-workflow)
+- [Coding Standards](#coding-standards)
+- [Testing](#testing)
+- [Documentation](#documentation)
+- [Pull Request Process](#pull-request-process)
+- [Release Process](#release-process)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [muditbhargava666@gmail.com](mailto:muditbhargava666@gmail.com).
+
+## Getting Started
+
+1. **Fork the repository** on GitHub.
+2. **Clone your fork** locally:
+   ```
+   git clone https://github.com/yourusername/Advanced-Image-Sensor-Interface.git
+   cd Advanced-Image-Sensor-Interface
+   ```
+3. **Set up the development environment**:
+   ```
+   python -m venv venv
+   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
+   pip install -e ".[dev,docs]"
+   ```
+4. **Create a new branch** for your feature or bug fix:
+   ```
+   git checkout -b feature/your-feature-name
+   ```
+
+## Development Workflow
+
+1. Make your changes in the appropriate files.
+2. Run the automated tests and linting:
+   ```
+   tox
+   ```
+3. If you've added new functionality, add tests for it in the `tests/` directory.
+4. Update documentation as needed in the `docs/` directory.
+5. Commit your changes with a descriptive commit message:
+   ```
+   git commit -m "Add feature: your feature description"
+   ```
+6. Push your branch to your fork:
+   ```
+   git push origin feature/your-feature-name
+   ```
+7. Create a pull request against the main repository.
+
+## Coding Standards
+
+This project follows these coding standards:
+
+- **PEP 8** for general Python coding style.
+- **Black** for code formatting (line length of 130 characters).
+- **MyPy** for type annotations.
+- **Ruff** for additional linting.
+
+These tools are configured in the `pyproject.toml` file and can be run using `tox` or directly.
+
+### Type Annotations
+
+All new code should include type annotations. Example:
+
+```python
+def calculate_snr(signal: np.ndarray, noise: np.ndarray) -> float:
+    """
+    Calculate the Signal-to-Noise Ratio.
+    
+    Args:
+        signal: The clean signal or reference image.
+        noise: The noise component.
+        
+    Returns:
+        The calculated SNR in decibels.
+    """
+    # Implementation...
+```
+
+## Testing
+
+This project uses `pytest` for testing. All new code should include appropriate tests.
+
+### Running Tests
+
+To run the tests:
+
+```
+pytest
+```
+
+For more detailed output:
+
+```
+pytest -v
+```
+
+To run tests with coverage:
+
+```
+pytest --cov=src
+```
+
+See the [Testing Guide](docs/testing_guide.md) for more detailed information on test design and implementation.
+
+## Documentation
+
+Documentation should be updated whenever you change code. This includes:
+
+- **Docstrings** for all modules, classes, and functions.
+- **API documentation** in `docs/api_documentation.md`.
+- **Design specifications** in `docs/design_specs.md` if you're making architectural changes.
+- **Performance analysis** in `docs/performance_analysis.md` if you're changing performance-critical code.
+
+### Building Documentation
+
+To build the documentation:
+
+```
+cd docs
+make html
+```
+
+The built documentation will be available in `docs/_build/html/`.
+
+## Pull Request Process
+
+1. Ensure your code passes all tests and linting checks.
+2. Update documentation as needed.
+3. Add your change to the CHANGELOG.md file in the "Unreleased" section.
+4. Make sure your PR description clearly describes the problem and solution. Include any relevant issue numbers.
+
+### PR Review Checklist
+
+Before submitting your PR, check that:
+
+- [ ] All tests pass, including any new tests for your feature
+- [ ] Code follows the project's coding standards
+- [ ] Documentation is updated
+- [ ] Changelog is updated
+
+## Release Process
+
+Releases are managed by the project maintainers. The process is as follows:
+
+1. Update the version number in `pyproject.toml`.
+2. Move entries from "Unreleased" to a new version section in CHANGELOG.md.
+3. Create a new GitHub release with the version number as the tag.
+4. Package and upload the release to PyPI.
+
+## Questions or Need Help?
+
+If you have questions or need help with the contribution process, please open an issue on GitHub or contact the project maintainers.
+
+Thank you for contributing to the Advanced Image Sensor Interface project!

README.md

@@ -1,21 +1,23 @@
+<div align="center">
+
 # Advanced Image Sensor Interface
 
 ![Project Banner](assets/image-sensor-interface-logo.png)
 
-![Python Version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue)
+[![Python Version](https://img.shields.io/badge/python-3.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/)
 ![License](https://img.shields.io/badge/license-MIT-green)
+[![CodeQL](https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface/actions/workflows/github-code-scanning/codeql)
 ![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
 ![Code Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen)
-![Documentation](https://img.shields.io/badge/docs-passing-brightgreen)
+[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Type Checking: Mypy & Pyright](https://img.shields.io/badge/types-mypy%20%7C%20pyright-%23eedc5b)](https://github.com/microsoft/pyright)
+[![Testing: pytest](https://img.shields.io/badge/testing-pytest-brightgreen)](https://docs.pytest.org/)
+[![Documentation Status](https://readthedocs.org/projects/advanced-image-sensor-interface/badge/?version=latest)](https://advanced-image-sensor-interface.readthedocs.io/en/latest/?badge=latest)
 ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
 ![Last Commit](https://img.shields.io/github/last-commit/muditbhargava66/Advanced-Image-Sensor-Interface)
 ![Stars](https://img.shields.io/github/stars/muditbhargava66/Advanced-Image-Sensor-Interface?style=social)
-
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
-[![Type Checking: mypy](https://img.shields.io/badge/type%20checking-mypy-brightgreen)](http://mypy-lang.org/)
-[![Linting: flake8](https://img.shields.io/badge/linting-flake8-brightgreen)](https://flake8.pycqa.org/)
-[![Testing: pytest](https://img.shields.io/badge/testing-pytest-brightgreen)](https://docs.pytest.org/)
+</div>
 
 ## Overview
 
@@ -34,6 +36,7 @@ This diagram illustrates the key components and data flow of our Advanced Image
 - **Efficient Power Management**: Reduces power consumption by 25% while maintaining high performance.
 - **Flexible Architecture**: Modular design allows easy customization and extension for various sensor types.
 - **Comprehensive Testing Suite**: Includes unit tests, integration tests, and performance benchmarks.
+- **Strict Type Checking**: Dual-layer type checking with both MyPy and Pyright.
 
 ## Technical Specifications
 
@@ -73,24 +76,30 @@ advanced_image_sensor_interface/
 ├── docs/
 │   ├── design_specs.md
 │   ├── performance_analysis.md
-│   └── api_documentation.md
+│   ├── api_documentation.md
+│   └── testing_guide.md
 ├── scripts/
 │   ├── simulation.py
 │   ├── data_analysis.py
 │   └── automated_testing.py
 ├── assets/
 │   └── logo.svg
 ├── README.md
+├── CHANGELOG.md
+├── CONTRIBUTING.md
 ├── requirements.txt
 ├── pyproject.toml
+├── tox.ini
+├── mypy.ini
+├── pyrightconfig.json
 └── .gitignore
 ```
 
 ## Installation
 
 1. Clone the repository:
    ```
-   git clone https://github.com/muditbhargava66/advanced_image_sensor_interface.git
+   git clone https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface.git
    cd advanced_image_sensor_interface
    ```
 
@@ -105,6 +114,11 @@ advanced_image_sensor_interface/
    pip install -r requirements.txt
    ```
 
+4. For development, install with the development and documentation dependencies:
+   ```
+   pip install -e ".[dev,docs]"
+   ```
+
 ## Usage
 
 ### Basic Usage
@@ -146,12 +160,20 @@ python scripts/data_analysis.py --plot --output analysis_results.json simulation
 
 ### Running Tests
 
-To run the automated test suite:
+To run the complete test suite using tox:
 
 ```
-python scripts/automated_testing.py --unit-tests --integration-tests --benchmarks --output test_results.json
+tox
 ```
 
+To run just the unit tests:
+
+```
+pytest
+```
+
+For more information on testing, see the [Testing Guide](docs/testing_guide.md).
+
 ## Performance Benchmarks
 
 | Metric | Value | Improvement |
@@ -168,6 +190,11 @@ Detailed documentation is available in the `docs/` directory:
 - [Design Specifications](docs/design_specs.md)
 - [API Documentation](docs/api_documentation.md)
 - [Performance Analysis](docs/performance_analysis.md)
+- [Testing Guide](docs/testing_guide.md)
+
+## Changelog
+
+For a detailed list of changes between versions, see the [CHANGELOG.md](CHANGELOG.md) file.
 
 ## Contributing
 
@@ -177,11 +204,25 @@ Contributions to the Advanced Image Sensor Interface project are welcome. Please
 
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## Contact
+<div align="center">
+
+## Star History
 
-For any questions or inquiries, please contact the project maintainer:
+<a href="https://star-history.com/#muditbhargava66/Advanced-Image-Sensor-Interface&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=muditbhargava66/Advanced-Image-Sensor-Interface&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=muditbhargava66/Advanced-Image-Sensor-Interface&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=muditbhargava66/Advanced-Image-Sensor-Interface&type=Date" />
+ </picture>
+</a>
 
-- Name: Mudit Bhargava
-- GitHub: [@muditbhargava66](https://github.com/muditbhargava66)
+---
 
----
+⭐️ Star the repo and consider contributing!  
+  
+📫 **Contact**: [@muditbhargava66](https://github.com/muditbhargava66)
+🐛 **Report Issues**: [Issue Tracker](https://github.com/muditbhargava66/Advanced-Image-Sensor-Interface/issues)
+  
+© 2025 Mudit Bhargava. [MIT License](LICENSE)  
+<!-- Copyright symbol using HTML entity for better compatibility -->
+</div>

benchmarks/__init__.py

@@ -1,5 +1,5 @@
 """
-Benchmarks Package for Advanced Image Sensor Interface
+Benchmarks Package for Advanced Image Sensor Interface.
 
 This package contains benchmark tests for evaluating the performance
 and quality of the Advanced Image Sensor Interface project.
@@ -9,11 +9,11 @@
     noise_analysis: Benchmarks for analyzing noise characteristics and reduction efficacy.
 """
 
-from .speed_tests import run_speed_benchmarks
 from .noise_analysis import run_noise_analysis
+from .speed_tests import run_speed_benchmarks
 
 __all__ = ['run_speed_benchmarks', 'run_noise_analysis']
 
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 __author__ = 'Mudit Bhargava'
 __license__ = 'MIT'