pyASDReader 1.2.0__tar.gz

pyasdreader-1.2.0/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+# Pre-commit hooks for pyASDReader project
+# See https://pre-commit.com for more information
+# Install: pip install pre-commit
+# Setup: pre-commit install
+# Run manually: pre-commit run --all-files
+
+repos:
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: \.md$
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ['--maxkb=1000']
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: mixed-line-ending
+
+  # Python code formatting
+  - repo: https://github.com/psf/black
+    rev: 23.12.1
+    hooks:
+      - id: black
+        language_version: python3
+        args: ['--line-length=120']
+
+  # Import sorting
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        args: ['--profile=black', '--line-length=120']
+
+  # Linting
+  - repo: https://github.com/PyCQA/flake8
+    rev: 7.0.0
+    hooks:
+      - id: flake8
+        args: ['--max-line-length=120', '--extend-ignore=E203,W503']
+        exclude: ^tests/

pyasdreader-1.2.0/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog - pyASDReader
+
+[![PyPI version](https://img.shields.io/pypi/v/pyASDReader.svg)](https://pypi.org/project/pyASDReader/)
+[![Version](https://img.shields.io/badge/version-v1.1.0-blue.svg)](https://github.com/KaiTastic/pyASDReader/releases)
+[![Semantic Versioning](https://img.shields.io/badge/semver-2.0.0-green.svg)](https://semver.org/spec/v2.0.0.html)
+[![Keep a Changelog](https://img.shields.io/badge/changelog-Keep%20a%20Changelog-orange.svg)](https://keepachangelog.com/en/1.0.0/)
+[![Latest Release](https://img.shields.io/github/v/release/KaiTastic/pyASDReader)](https://github.com/KaiTastic/pyASDReader/releases/latest)
+[![Release Date](https://img.shields.io/github/release-date/KaiTastic/pyASDReader)](https://github.com/KaiTastic/pyASDReader/releases)
+
+All notable changes to this project will be documented in this file.
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), and the format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+
+## [1.1.0] - 2025-10-05
+
+### Fixed
+- 🔴 **Critical**: Removed broken root `__init__.py` that caused ModuleNotFoundError
+- 🔴 **Critical**: Fixed pyproject.toml package configuration for proper pip installation
+- 🔴 **Critical**: Unified version management (removed conflicting version definitions)
+- 🔴 **Critical**: Fixed GitHub Actions branch configuration (now triggers on main branch)
+- 🔴 **Critical**: Removed conflicting setup.py (now using only pyproject.toml)
+- 🔴 Fixed binary flag error in SWIR2_TEC_ALARM detection (0x16 → 0x10)
+- 🟠 Fixed read() method to properly return False on file errors
+- ⚠️ Fixed logger undefined error by adding module-level logger
+- ⚠️ Added Python 3.8 compatibility with `from __future__ import annotations`
+
+### Changed
+- 🔄 **Repository renamed** from `ASD_File_Reader` to `pyASDReader` for consistency with PyPI package name
+- 📦 **PyPI package name**: `pyASDReader` (install: `pip install pyASDReader`)
+- 🏠 **New repository URL**: https://github.com/KaiTastic/pyASDReader
+- ℹ️ **Module import**: `from pyASDReader import ASDFile` (improved package exports)
+- 🧪 GitHub Actions now tests stable Python versions only (3.8-3.12, removed 3.13 and 3.x)
+- 🧪 Removed `continue-on-error` from CI to properly report test failures
+- 📊 Test matrix reduced from 21 to 15 combinations for better stability
+- Modernized dependency management: moved all dependencies to pyproject.toml optional-dependencies
+- Updated all CI/CD workflows to use `pip install -e ".[dev]"` instead of requirements files
+- Enhanced README with Development Installation section
+- Standardized version number to 1.1.0 across all configuration files
+
+### Added
+- ✨ Automatic version management using setuptools-scm
+- 🤖 Dual GitHub Actions workflows: dev branch → TestPyPI, tag → PyPI
+- 📚 Comprehensive documentation for version management and publishing
+- 📝 CLAUDE.md - Guide for Claude Code integration
+- 📝 VERSION_MANAGEMENT.md - Complete guide for version management with Git tags and setuptools_scm
+- 📝 SECURITY.md - Security policy and vulnerability reporting guidelines
+- 📝 PROJECT_IMPROVEMENT_ANALYSIS.md - Detailed analysis of 26 issues
+- 📝 FIXES_APPLIED.md - First round fix summary
+- 📝 ADDITIONAL_IMPROVEMENTS.md - Second round analysis of 15 issues
+- 📝 ROUND2_FIXES_APPLIED.md - Second round fix summary
+- ✅ Support for auto-loading files: `ASDFile(filepath)` constructor
+- Added examples/ directory with basic usage examples
+- Enhanced project URLs in pyproject.toml (Issues, Source, Changelog, PyPI)
+- Comprehensive optional-dependencies groups: dev, docs, all
+
+### Removed
+- ❌ Deleted conflicting `setup.py`
+- ❌ Deleted broken root `__init__.py`
+- ❌ Deleted requirements.txt (moved to pyproject.toml)
+- ❌ Deleted requirements-dev.txt (moved to pyproject.toml)
+- ❌ Removed duplicate v1.0.0 git tag
+
+### Note
+- Old repository URLs will redirect automatically
+- No breaking changes for existing users - all fixes are backward compatible
+- Package is now fully functional (fixed from "broken" state)
+- Version management now uses Git tags as single source of truth
+
+## [1.0.1] - 2025-08-29
+
+### Added
+
+- Enhanced README documentation with compatibility testing details
+- Improved GitHub Actions CI/CD workflow with multi-platform testing
+- Extended Python version support (3.8-3.13)
+- Code quality improvements and linting integration (flake8)
+- Comprehensive badge system showing CI status, version, Python compatibility, and license
+
+### Changed
+
+- Updated documentation structure and clarity
+- Improved project organization and maintainability
+- Enhanced cross-platform compatibility testing
+
+### Fixed
+
+- Minor documentation formatting issues
+- CI/CD pipeline optimizations
+
+## [1.0.0] - 2025-03-12
+
+### Added
+
+- Initial release with full ASD file format support (versions 1-8)
+- Comprehensive parsing capabilities for all ASD file structures:
+  - Spectrum File Header and metadata
+  - Spectrum Data parsing
+  - Reference File Header and Reference Data
+  - Classifier Data support
+  - Dependent Variables handling
+  - Calibration Header and calibration series data
+  - Audit Log parsing
+  - Digital signature support
+- Benchmark testing against ASD ViewSpecPro 6.2.0 for accuracy validation
+- Support for multiple ASD instrument types:
+  - ASD AgriSpec, FieldSpec series, HandHeld 2, LabSpec series, TerraSpec series
+- Spectral data processing capabilities:
+  - Digital number extraction
+  - Reflectance calculations (with derivatives)
+  - Absolute reflectance
+  - log(1/R) calculations
+  - Transmittance support
+- Comprehensive unit test suite
+- MIT License
+- Python package structure with setuptools support
+
+### Features
+
+- **File Format Compatibility**: Complete support for ASD file format versions 1 through 8
+- **Multi-instrument Support**: Works with all major ASD spectroradiometer models
+- **Data Extraction**: Full access to all data blocks within ASD files
+- **Calculation Support**: Built-in spectral calculations and transformations
+- **Validation**: Benchmark-tested against official ASD software
+
+## Upcoming Features
+
+- [ ] Spectral discontinuities correction (Hueni & ASD Parabolic methods)
+- [ ] File format converter (ASCII export functionality)
+- [ ] Enhanced radiometric and statistical tools
+- [ ] Extended instrument support and metadata extraction
+- [ ] PyPI package distribution

pyasdreader-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kai Cao
+
+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.

pyasdreader-1.2.0/MANIFEST.in

@@ -0,0 +1,50 @@
+# MANIFEST.in - Include additional files in source distribution
+
+# Documentation
+include README.md
+include LICENSE
+include CHANGELOG.md
+include SECURITY.md
+
+# Configuration files
+include pyproject.toml
+
+# Source code and data files
+recursive-include src *.py
+recursive-include src *.mat
+
+# Tests (optional - include if you want tests in sdist)
+recursive-include tests *.py
+recursive-include tests/sample_data *.asd
+
+# Exclude unwanted files
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store
+recursive-exclude * *.swp
+recursive-exclude * *~
+
+# Exclude build artifacts
+exclude .gitignore
+exclude .coverage
+exclude htmlcov
+prune build
+prune dist
+prune *.egg-info
+prune .pytest_cache
+prune .tox
+prune .venv
+prune venv
+prune env
+
+# Exclude analysis and documentation files (they're in git but not needed in package)
+exclude PROJECT_IMPROVEMENT_ANALYSIS.md
+exclude ADDITIONAL_IMPROVEMENTS.md
+exclude FIXES_APPLIED.md
+exclude ROUND2_FIXES_APPLIED.md
+exclude CLAUDE.md
+
+# Exclude workflow and IDE files
+prune .github
+prune .vscode
+prune .idea