PyPI - pyASDReader - Versions diffs - 1.2.1__tar.gz → 1.2.3__tar.gz - Mend

pyASDReader 1.2.1tar.gz → 1.2.3tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (41) hide show

pyasdreader-1.2.3/.codecov.yml ADDED Viewed

@@ -0,0 +1,68 @@
+codecov:
+  require_ci_to_pass: yes
+  notify:
+    wait_for_ci: yes
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+        informational: false
+    patch:
+      default:
+        target: auto
+        threshold: 1%
+        informational: false
+comment:
+  layout: "reach,diff,flags,files,footer"
+  behavior: default
+  require_changes: false
+  require_base: false
+  require_head: true
+flags:
+  ubuntu-latest-py3.8:
+    carryforward: false
+  ubuntu-latest-py3.9:
+    carryforward: false
+  ubuntu-latest-py3.10:
+    carryforward: false
+  ubuntu-latest-py3.11:
+    carryforward: false
+  ubuntu-latest-py3.12:
+    carryforward: false
+  windows-latest-py3.8:
+    carryforward: false
+  windows-latest-py3.9:
+    carryforward: false
+  windows-latest-py3.10:
+    carryforward: false
+  windows-latest-py3.11:
+    carryforward: false
+  windows-latest-py3.12:
+    carryforward: false
+  macos-latest-py3.8:
+    carryforward: false
+  macos-latest-py3.9:
+    carryforward: false
+  macos-latest-py3.10:
+    carryforward: false
+  macos-latest-py3.11:
+    carryforward: false
+  macos-latest-py3.12:
+    carryforward: false
+ignore:
+  - "tests/"
+  - "examples/"
+  - "docs/"
+  - "scripts/"
+  - "**/__pycache__"
+  - "*.pyc"

{pyasdreader-1.2.1 → pyasdreader-1.2.3}/CHANGELOG.md RENAMED Viewed

@@ -13,6 +13,96 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [Unreleased]
+## [1.2.3] - 2025-10-07
+### Added
+- 📚 **Documentation Section** - Added comprehensive documentation links in README.md
+  - Link to CHANGELOG.md for version history and feature updates
+  - Link to VERSION_MANAGEMENT.md for release workflow and branch strategy
+  - Links to GitHub Issues and Discussions for community engagement
+### Changed
+- 🏗️ **Branch Strategy Documentation** - Major update to VERSION_MANAGEMENT.md
+  - Added detailed branch strategy section explaining dev/main workflow
+  - Updated release workflow with 4-step process including branch merge requirement
+  - Enhanced publishing scenarios (normal release, hotfix, quick release)
+  - Expanded best practices from 8 to 10 comprehensive guidelines
+  - Updated quick reference with branch-specific commands
+- 🔄 **Enhanced CI/CD Workflows** - Intelligent optimization for GitHub Actions
+  - Added TestPyPI test reuse mechanism in PyPI workflow (saves approximately 45 minutes per release)
+  - Implemented 7-day test validity window for TestPyPI results
+  - Added verification summary job with detailed test status reporting
+  - Optimized GitHub Actions minutes usage (approximately 40% savings)
+  - Enhanced workflow comments and documentation
+### Fixed
+- 🐛 **Python 3.8 Compatibility** - Resolved f-string syntax issues in CI workflows
+  - Fixed package metadata verification step in publish-to-pypi.yml
+  - Fixed package metadata verification step in publish-to-testpypi.yml
+  - Resolved f-string backslash syntax error (not supported in Python 3.8)
+  - Ensured compatibility across all supported Python versions (3.8-3.12)
+### Technical Improvements
+- Better CI/CD resource optimization with intelligent test reuse
+- Clearer release workflow documentation for contributors
+- Improved branch management guidelines
+- Enhanced Python version compatibility in automated workflows
+## [1.2.2] - 2025-10-05
+### Added
+- 📋 **Codecov Configuration** - Added `.codecov.yml` for comprehensive code coverage tracking
+  - Multi-platform coverage flags (Ubuntu, Windows, macOS)
+  - Per-Python-version coverage tracking (3.8-3.12)
+  - Automatic coverage status checks on PRs
+  - Detailed coverage reporting with customizable thresholds
+- ✅ **Enhanced Test Suite** - Significantly expanded test coverage
+  - Added `test_file_attributes.py` with 12 comprehensive test cases for FileAttributes class
+  - Expanded `test_asd_file_reader.py` with new property tests and validation tests
+  - Added tests for spectral data parsing, constituent types, BSTR, and audit events
+  - Improved test coverage for file version validation, GPS parsing, and datetime handling
+- 📊 **Coverage Reporting** - Added `coverage.json` for detailed coverage metrics
+  - Per-file coverage statistics
+  - Function-level coverage tracking
+  - Class-level coverage analysis
+### Changed
+- 🏗️ **Improved Code Structure** - Enhanced ASDFile class inheritance
+  - `ASDFile` now properly inherits from `FileAttributes` class
+  - Better integration of file handling capabilities
+  - Improved logger initialization with proper setup in module scope
+- 🔧 **Optimized CI/CD Workflows** - Performance improvements for GitHub Actions
+  - Removed redundant pip caching from PyPI verification steps
+  - Streamlined publish workflows for faster deployments
+- 📚 **Updated Documentation** - Improved README formatting
+  - Fixed test workflow badge to reference correct workflow file
+  - Cleaned up citation section for better readability
+  - Removed verbose contribution and community sections for conciseness
+### Fixed
+- 🐛 **Fixed FileAttributes Methods** - Corrected attribute naming inconsistencies
+  - Fixed `set_file_name()` method to use `self.filename` instead of `self.file_name`
+  - Fixed `set_file_path()` method to use `self.filepath` instead of `self.file_path`
+  - Improved consistency across FileAttributes class methods
+- 🔧 **Enhanced Test Robustness** - Improved test initialization and execution
+  - Fixed ASDFile test initialization to work without parent class conflicts
+  - Added proper subTest contexts for all file iteration tests
+  - Improved error handling in test cases
+### Removed
+- ❌ **CITATION.cff** - Temporarily removed to streamline package metadata
+  - Citation information now maintained in README only
+  - Reduces maintenance overhead for version updates
+  - GitHub citation feature still available via repository metadata
+### Technical Improvements
+- Better test organization with comprehensive property testing
+- Improved code coverage from ~61% to higher levels across core modules
+- Enhanced file attribute handling with proper inheritance chain
+- More reliable CI/CD pipeline with optimized caching strategy
+- Better separation of concerns between file I/O and ASD parsing logic
 ## [1.2.1] - 2025-10-05
 ### Added

{pyasdreader-1.2.1 → pyasdreader-1.2.3}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyASDReader
-Version: 1.2.1
+Version: 1.2.3
 Summary: A Python library for reading and parsing all versions of ASD binary spectral files
 Author-email: Kai Cao <caokai_cgs@163.com>
 Maintainer-email: Kai Cao <caokai_cgs@163.com>
@@ -86,7 +86,7 @@ Dynamic: license-file
 [![PyPI version](https://img.shields.io/pypi/v/pyASDReader?style=flat-square)](https://pypi.org/project/pyASDReader/)
 [![Python versions](https://img.shields.io/pypi/pyversions/pyASDReader?style=flat-square)](https://pypi.org/project/pyASDReader/)
 [![License](https://img.shields.io/github/license/KaiTastic/pyASDReader?style=flat-square)](https://github.com/KaiTastic/pyASDReader/blob/main/LICENSE)
-[![Tests](https://img.shields.io/github/actions/workflow/status/KaiTastic/pyASDReader/test.yml?branch=main&label=tests&style=flat-square)](https://github.com/KaiTastic/pyASDReader/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/KaiTastic/pyASDReader/python-package.yml?branch=main&label=tests&style=flat-square)](https://github.com/KaiTastic/pyASDReader/actions)
 [![Coverage](https://img.shields.io/codecov/c/github/KaiTastic/pyASDReader?style=flat-square)](https://codecov.io/gh/KaiTastic/pyASDReader)
 pyASDReader is a robust Python library designed to read and parse all versions (v1-v8) of ASD (Analytical Spectral Devices) binary spectral files. It provides seamless access to spectral data, metadata, and calibration information from various ASD instruments including FieldSpec, LabSpec, TerraSpec, and more.
@@ -142,6 +142,13 @@ pip install -e ".[dev]"
 pip install -e ".[all]"
 ```
+## Documentation
+- **[CHANGELOG](CHANGELOG.md)** - Version history, feature updates, and bug fixes
+- **[Version Management Guide](VERSION_MANAGEMENT.md)** - Release workflow, branch strategy, and CI/CD automation
+- **[GitHub Issues](https://github.com/KaiTastic/pyASDReader/issues)** - Report bugs and request features
+- **[GitHub Discussions](https://github.com/KaiTastic/pyASDReader/discussions)** - Ask questions and share ideas
 ## Quick Start
 ```python
@@ -388,67 +395,9 @@ Comprehensive export capabilities beyond the standard ASCII format:
 - Integration with popular spectral analysis libraries
-## Contributing
-### Development Setup
-1. **Fork and Clone**:
-   ```bash
-   git clone https://github.com/yourusername/pyASDReader.git
-   cd pyASDReader
-   ```
-2. **Create Development Environment**:
-   ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   pip install -e ".[dev]"
-   ```
-3. **Run Tests**:
-   ```bash
-   pytest tests/
-   python -m pytest --cov=src --cov-report=html
-   ```
-### Contribution Guidelines
-- **Bug Reports**: Use GitHub Issues with detailed reproduction steps
-- **Feature Requests**: Open an issue to discuss before implementing
-- **Code Style**: Follow PEP 8 and use provided pre-commit hooks
-- **Testing**: Add tests for new features and ensure all tests pass
-- **Documentation**: Update README and docstrings for any API changes
-### Development Workflow
-1. Create a feature branch: `git checkout -b feature/amazing-feature`
-2. Make your changes with appropriate tests
-3. Run the test suite: `pytest`
-4. Commit your changes: `git commit -m 'Add amazing feature'`
-5. Push to your fork: `git push origin feature/amazing-feature`
-6. Submit a Pull Request
-## � Support & Community
-### Getting Help
-- 📋 **GitHub Issues**: [Report bugs or request features](https://github.com/KaiTastic/pyASDReader/issues)
-- 📧 **Email**: `caokai_cgs@163.com` for direct support
-- 🔒 **Security**: Report vulnerabilities via the [Security Policy](SECURITY.md)
-### Community Guidelines
-- Be respectful and inclusive
-- Help others learn and grow
-- Share knowledge and experiences
-- Provide constructive feedback
 ## Citation
-If you use pyASDReader in your research, please cite it using the information from t he [CITATION.cff](CITATION.cff) file.
-GitHub provides a "Cite this repository" button in the sidebar that automatically generates citations in multiple formats.
+If you use pyASDReader in your research, please cite it using the following information:
 **BibTeX format**:
 ```bibtex
@@ -457,16 +406,16 @@ GitHub provides a "Cite this repository" button in the sidebar that automaticall
   title = {pyASDReader: A Python Library for ASD Spectral File Reading},
   year = {2025},
   url = {https://github.com/KaiTastic/pyASDReader},
-  version = {see CITATION.cff for latest version}
+  version = {1.2.3}
 }
 ```
 **Plain text citation**:
-> Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. Available at: https://github.com/KaiTastic/pyASDReader
-For the most up-to-date version number and citation details, please refer to the [CITATION.cff](CITATION.cff) file or use GitHub's citation feature.
+```
+Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. Available at: https://github.com/KaiTastic/pyASDReader
+```
-## 📖 References
+## References
 ### Official Documentation
 - [ASD Inc. (2017). ASD File Format: Version 8 (Revision): 1-10](https://www.malvernpanalytical.com/en/learn/knowledge-center/user-manuals/asd-file-format-v8)

{pyasdreader-1.2.1 → pyasdreader-1.2.3}/README.md RENAMED Viewed

@@ -3,7 +3,7 @@
 [![PyPI version](https://img.shields.io/pypi/v/pyASDReader?style=flat-square)](https://pypi.org/project/pyASDReader/)
 [![Python versions](https://img.shields.io/pypi/pyversions/pyASDReader?style=flat-square)](https://pypi.org/project/pyASDReader/)
 [![License](https://img.shields.io/github/license/KaiTastic/pyASDReader?style=flat-square)](https://github.com/KaiTastic/pyASDReader/blob/main/LICENSE)
-[![Tests](https://img.shields.io/github/actions/workflow/status/KaiTastic/pyASDReader/test.yml?branch=main&label=tests&style=flat-square)](https://github.com/KaiTastic/pyASDReader/actions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/KaiTastic/pyASDReader/python-package.yml?branch=main&label=tests&style=flat-square)](https://github.com/KaiTastic/pyASDReader/actions)
 [![Coverage](https://img.shields.io/codecov/c/github/KaiTastic/pyASDReader?style=flat-square)](https://codecov.io/gh/KaiTastic/pyASDReader)
 pyASDReader is a robust Python library designed to read and parse all versions (v1-v8) of ASD (Analytical Spectral Devices) binary spectral files. It provides seamless access to spectral data, metadata, and calibration information from various ASD instruments including FieldSpec, LabSpec, TerraSpec, and more.
@@ -59,6 +59,13 @@ pip install -e ".[dev]"
 pip install -e ".[all]"
 ```
+## Documentation
+- **[CHANGELOG](CHANGELOG.md)** - Version history, feature updates, and bug fixes
+- **[Version Management Guide](VERSION_MANAGEMENT.md)** - Release workflow, branch strategy, and CI/CD automation
+- **[GitHub Issues](https://github.com/KaiTastic/pyASDReader/issues)** - Report bugs and request features
+- **[GitHub Discussions](https://github.com/KaiTastic/pyASDReader/discussions)** - Ask questions and share ideas
 ## Quick Start
 ```python
@@ -305,67 +312,9 @@ Comprehensive export capabilities beyond the standard ASCII format:
 - Integration with popular spectral analysis libraries
-## Contributing
-### Development Setup
-1. **Fork and Clone**:
-   ```bash
-   git clone https://github.com/yourusername/pyASDReader.git
-   cd pyASDReader
-   ```
-2. **Create Development Environment**:
-   ```bash
-   python -m venv venv
-   source venv/bin/activate  # On Windows: venv\Scripts\activate
-   pip install -e ".[dev]"
-   ```
-3. **Run Tests**:
-   ```bash
-   pytest tests/
-   python -m pytest --cov=src --cov-report=html
-   ```
-### Contribution Guidelines
-- **Bug Reports**: Use GitHub Issues with detailed reproduction steps
-- **Feature Requests**: Open an issue to discuss before implementing
-- **Code Style**: Follow PEP 8 and use provided pre-commit hooks
-- **Testing**: Add tests for new features and ensure all tests pass
-- **Documentation**: Update README and docstrings for any API changes
-### Development Workflow
-1. Create a feature branch: `git checkout -b feature/amazing-feature`
-2. Make your changes with appropriate tests
-3. Run the test suite: `pytest`
-4. Commit your changes: `git commit -m 'Add amazing feature'`
-5. Push to your fork: `git push origin feature/amazing-feature`
-6. Submit a Pull Request
-## � Support & Community
-### Getting Help
-- 📋 **GitHub Issues**: [Report bugs or request features](https://github.com/KaiTastic/pyASDReader/issues)
-- 📧 **Email**: `caokai_cgs@163.com` for direct support
-- 🔒 **Security**: Report vulnerabilities via the [Security Policy](SECURITY.md)
-### Community Guidelines
-- Be respectful and inclusive
-- Help others learn and grow
-- Share knowledge and experiences
-- Provide constructive feedback
 ## Citation
-If you use pyASDReader in your research, please cite it using the information from t he [CITATION.cff](CITATION.cff) file.
-GitHub provides a "Cite this repository" button in the sidebar that automatically generates citations in multiple formats.
+If you use pyASDReader in your research, please cite it using the following information:
 **BibTeX format**:
 ```bibtex
@@ -374,16 +323,16 @@ GitHub provides a "Cite this repository" button in the sidebar that automaticall
   title = {pyASDReader: A Python Library for ASD Spectral File Reading},
   year = {2025},
   url = {https://github.com/KaiTastic/pyASDReader},
-  version = {see CITATION.cff for latest version}
+  version = {1.2.3}
 }
 ```
 **Plain text citation**:
-> Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. Available at: https://github.com/KaiTastic/pyASDReader
-For the most up-to-date version number and citation details, please refer to the [CITATION.cff](CITATION.cff) file or use GitHub's citation feature.
+```
+Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. Available at: https://github.com/KaiTastic/pyASDReader
+```
-## 📖 References
+## References
 ### Official Documentation
 - [ASD Inc. (2017). ASD File Format: Version 8 (Revision): 1-10](https://www.malvernpanalytical.com/en/learn/knowledge-center/user-manuals/asd-file-format-v8)

pyASDReader 1.2.1__tar.gz → 1.2.3__tar.gz

pyASDReader 1.2.1tar.gz → 1.2.3tar.gz