pyASDReader 1.2.0__tar.gz → 1.2.1__tar.gz

{pyasdreader-1.2.0 → pyasdreader-1.2.1}/CHANGELOG.md

@@ -13,6 +13,101 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+## [1.2.1] - 2025-10-05
+
+### Added
+- ✨ **CITATION.cff** - Academic citation file for proper software citation
+  - Includes author information with ORCID placeholder
+  - Comprehensive metadata (abstract, keywords, repository info)
+  - MIT license specification
+  - Version and release date tracking
+- 📤 CITATION.cff now included in GitHub releases
+- 🔄 Automatic CITATION.cff version and date updates during release
+- 📊 Codecov integration for code coverage reporting
+  - Automatic coverage upload after test runs
+  - Per-platform and per-Python-version coverage tracking
+  - Coverage badges support
+
+### Changed
+- 🚀 Enhanced CI/CD workflows with performance improvements:
+  - Upgraded `actions/setup-python` from v4 to v5
+  - Added pip caching to all workflows for faster builds
+  - Streamlined cache configuration (removed redundant cache steps)
+  - Improved cache key structure using pyproject.toml
+- 🧪 Improved test workflow (`python-package.yml`):
+  - Better pip caching strategy
+  - Enhanced coverage reporting with Codecov
+  - More efficient dependency caching
+- 📦 Enhanced PyPI publishing workflow:
+  - Added CITATION.cff to release assets
+  - Automatic citation file updates on tag releases
+  - Improved release notes generation
+- 📚 Updated README.md with better formatting and organization
+
+### Fixed
+- 🔧 Fixed package metadata verification using `importlib.metadata` instead of manual version checking
+  - More accurate and reliable version detection
+  - Better compatibility with different Python versions
+  - Improved error handling in CI/CD pipelines
+
+### Technical Improvements
+- Reduced workflow execution time through better caching
+- Enhanced CI/CD reliability with updated actions
+- Improved maintainability of GitHub Actions workflows
+- Better separation of concerns in workflow steps
+- More robust release automation
+
+## [1.2.0] - 2025-10-05
+
+### Changed
+- 🔄 **Package renamed** from `pyASD` to `pyASDReader` across all configuration files
+- 📦 Updated package configuration in pyproject.toml with improved metadata
+- 🏗️ **Major code structure refactoring** for improved readability and maintainability
+- 📚 Significantly enhanced README.md with comprehensive documentation
+- 🔧 Modernized dependency management with expanded dev tools
+- 🧪 Improved CI/CD workflows for better reliability and accuracy
+- 📝 Updated all GitHub Actions workflows to use correct branch references (main)
+- 🎯 Enhanced pre-commit configuration for better code quality
+- 🚀 Improved publish scripts with better error handling
+
+### Added
+- ✨ **CITATION.cff** - Formal citation support for academic use
+- 📚 **VERSION_MANAGEMENT.md** - Comprehensive version management documentation
+- 📝 **examples/README.md** - Detailed examples documentation
+- 📝 **examples/basic_usage.py** - Practical usage examples
+- 🛠️ Enhanced development dependencies:
+  - Added `black>=21.0.0` for code formatting
+  - Added `isort>=5.0.0` for import sorting
+  - Added `build>=0.7.0` for package building
+  - Added `twine>=3.0.0` for PyPI publishing
+  - Added `pre-commit>=2.15.0` for git hooks
+  - Added `tox>=3.20.0` for testing automation
+- 🎨 Added maintainers field to project metadata
+- 📦 Added "all" optional dependencies group for complete installation
+- 🔗 Enhanced project URLs with Source and Issues links
+- 📄 Improved README content-type specification in pyproject.toml
+- ✅ Enhanced package metadata verification using importlib.metadata
+- 🔍 Improved CI workflows with better testing and validation
+
+### Removed
+- ❌ **Deleted requirements.txt** (consolidated into pyproject.toml)
+- ❌ **Deleted requirements-dev.txt** (consolidated into pyproject.toml)
+- ❌ **Deleted setup.py** (fully migrated to pyproject.toml)
+
+### Fixed
+- 🔧 Fixed package metadata verification in CI/CD workflows
+- ✅ Corrected test file naming convention (test_ASD_File_Reader.py → test_asd_file_reader.py)
+- 🔗 Updated all repository URLs from pyASD to pyASDReader
+- 📝 Fixed MANIFEST.in to properly include package data
+- 🐛 Improved error handling in asd_file_reader.py
+
+### Technical Improvements
+- Centralized all dependencies in pyproject.toml optional-dependencies
+- Improved package structure with proper namespace configuration
+- Enhanced setuptools_scm integration for version management
+- Better test coverage configuration targeting pyASDReader module
+- Streamlined build and publish workflows
+
 ## [1.1.0] - 2025-10-05
 
 ### Fixed

pyasdreader-1.2.1/CITATION.cff

@@ -0,0 +1,22 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "pyASDReader: A Python Library for ASD Spectral File Reading"
+authors:
+  - family-names: Cao
+    given-names: Kai
+    email: caokai_cgs@163.com
+    orcid: https://orcid.org/0000-0000-0000-0000
+repository-code: "https://github.com/KaiTastic/pyASDReader"
+url: "https://github.com/KaiTastic/pyASDReader"
+abstract: "A Python library for reading and parsing all versions (v1-v8) of ASD (Analytical Spectral Devices) binary spectral files from various instruments including FieldSpec, LabSpec, and TerraSpec spectroradiometers."
+keywords:
+  - ASD
+  - spectral files
+  - spectroradiometer
+  - remote sensing
+  - hyperspectral
+  - FieldSpec
+license: MIT
+version: 1.0.0
+date-released: 2025-03-12

{pyasdreader-1.2.0 → pyasdreader-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyASDReader
-Version: 1.2.0
+Version: 1.2.1
 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>
@@ -435,7 +435,7 @@ Comprehensive export capabilities beyond the standard ASCII format:
 
 - 📋 **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 our [Security Policy](SECURITY.md)
+- 🔒 **Security**: Report vulnerabilities via the [Security Policy](SECURITY.md)
 
 ### Community Guidelines
 
@@ -446,20 +446,25 @@ Comprehensive export capabilities beyond the standard ASCII format:
 
 ## Citation
 
-If you use pyASDReader in your research, please cite:
+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.
+
+**BibTeX format**:
 ```bibtex
 @software{cao2025pyasdreader,
   author = {Cao, Kai},
   title = {pyASDReader: A Python Library for ASD Spectral File Reading},
   year = {2025},
   url = {https://github.com/KaiTastic/pyASDReader},
-  version = {1.0.0}
+  version = {see CITATION.cff for latest version}
 }
 ```
 
 **Plain text citation**:
-> Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. https://github.com/KaiTastic/pyASDReader
+> 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.
 
 ## 📖 References
 
@@ -476,12 +481,6 @@ If you use pyASDReader in your research, please cite:
 
 This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for complete details.
 
-### Built With
-
-- [NumPy](https://numpy.org/) - Numerical computing library
-- [Python](https://python.org/) - Programming language
-- [pytest](https://pytest.org/) - Testing framework
-
 ---
 
 <div align="center">

{pyasdreader-1.2.0 → pyasdreader-1.2.1}/README.md

@@ -352,7 +352,7 @@ Comprehensive export capabilities beyond the standard ASCII format:
 
 - 📋 **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 our [Security Policy](SECURITY.md)
+- 🔒 **Security**: Report vulnerabilities via the [Security Policy](SECURITY.md)
 
 ### Community Guidelines
 
@@ -363,20 +363,25 @@ Comprehensive export capabilities beyond the standard ASCII format:
 
 ## Citation
 
-If you use pyASDReader in your research, please cite:
+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.
+
+**BibTeX format**:
 ```bibtex
 @software{cao2025pyasdreader,
   author = {Cao, Kai},
   title = {pyASDReader: A Python Library for ASD Spectral File Reading},
   year = {2025},
   url = {https://github.com/KaiTastic/pyASDReader},
-  version = {1.0.0}
+  version = {see CITATION.cff for latest version}
 }
 ```
 
 **Plain text citation**:
-> Cao, Kai. (2025). pyASDReader: A Python Library for ASD Spectral File Reading. https://github.com/KaiTastic/pyASDReader
+> 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.
 
 ## 📖 References
 
@@ -393,12 +398,6 @@ If you use pyASDReader in your research, please cite:
 
 This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for complete details.
 
-### Built With
-
-- [NumPy](https://numpy.org/) - Numerical computing library
-- [Python](https://python.org/) - Programming language
-- [pytest](https://pytest.org/) - Testing framework
-
 ---
 
 <div align="center">

{pyasdreader-1.2.0 → pyasdreader-1.2.1}/pyASDReader.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 .pre-commit-config.yaml
 CHANGELOG.md
+CITATION.cff
 LICENSE
 MANIFEST.in
 README.md