Skip to content

Commit 40e90bf

Browse files
areias03Copilot
andcommitted
docs: add CHANGELOG.md for v0.2.0 release
Document all changes since v0.1.0 including: - New features: contig depths, study downloads, disk caching - Improved type hints and code quality - Bug fixes for URLs and metadata handling - Extensive documentation improvements - Enhanced test coverage Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 0603ef6 commit 40e90bf

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

CHANGELOG.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.2.0] - 2026-03-23
11+
12+
### Added
13+
- Full download functionality for study data ([e6d9fe9](https://github.com/areias03/SPIREpy/commit/e6d9fe9))
14+
- Sample contig depths feature ([a972e4f](https://github.com/areias03/SPIREpy/commit/a972e4f))
15+
- Disk caching for cluster and genome metadata ([700d693](https://github.com/areias03/SPIREpy/commit/700d693))
16+
- Comprehensive unit and integration tests for data functions ([b61a145](https://github.com/areias03/SPIREpy/commit/b61a145))
17+
- Docstring and type hint for `get_contig_depths()` method ([0603ef6](https://github.com/areias03/SPIREpy/commit/0603ef6))
18+
19+
### Changed
20+
- Improved type hints: updated return type annotations to use `pl.DataFrame` instead of `pl.dataframe.DataFrame` ([072f10b](https://github.com/areias03/SPIREpy/commit/072f10b))
21+
- Added `Union` type hint for `get_amr_annotations()` to properly handle `None` return ([072f10b](https://github.com/areias03/SPIREpy/commit/072f10b))
22+
- Use more Polars-style code patterns ([35e460d](https://github.com/areias03/SPIREpy/commit/35e460d))
23+
- Use "SPIREpy" as logger name ([5ec51a7](https://github.com/areias03/SPIREpy/commit/5ec51a7))
24+
- Only import pandas when needed to improve performance ([4b9fc13](https://github.com/areias03/SPIREpy/commit/4b9fc13))
25+
- Improved code formatting and consistency in test files ([072f10b](https://github.com/areias03/SPIREpy/commit/072f10b))
26+
27+
### Fixed
28+
- Sample and study metadata URL handling ([c73b09d](https://github.com/areias03/SPIREpy/commit/c73b09d))
29+
- Unit testing calls and expected URL ([d3e7ec3](https://github.com/areias03/SPIREpy/commit/d3e7ec3))
30+
- Adapted unit tests to new function signatures ([e9e9e8c](https://github.com/areias03/SPIREpy/commit/e9e9e8c))
31+
- `sample.get_mags()` now correctly reads genome metadata ([eaec357](https://github.com/areias03/SPIREpy/commit/eaec357))
32+
- Import error resolution ([0e71aa4](https://github.com/areias03/SPIREpy/commit/0e71aa4))
33+
- Double calls on methods ([febefaf](https://github.com/areias03/SPIREpy/commit/febefaf))
34+
35+
### Removed
36+
- Multithreading utilities ([e06f92a](https://github.com/areias03/SPIREpy/commit/e06f92a))
37+
- Unnecessary comments in view.py ([072f10b](https://github.com/areias03/SPIREpy/commit/072f10b))
38+
39+
### Documentation
40+
- Added comprehensive docstring for `get_contig_depths()` method ([0603ef6](https://github.com/areias03/SPIREpy/commit/0603ef6))
41+
- Added function docstrings for better code documentation ([2f682f4](https://github.com/areias03/SPIREpy/commit/2f682f4))
42+
- Better docstrings throughout the codebase ([6e4d027](https://github.com/areias03/SPIREpy/commit/6e4d027))
43+
- Major improvements to documentation ([4424408](https://github.com/areias03/SPIREpy/commit/4424408))
44+
- Fixes to Sphinx documentation generation ([b8f2314](https://github.com/areias03/SPIREpy/commit/b8f2314))
45+
- Improvements to ReadTheDocs configuration ([afb917e](https://github.com/areias03/SPIREpy/commit/afb917e))
46+
- Formatting improvements for Sphinx docstrings ([e25d7b7](https://github.com/areias03/SPIREpy/commit/e25d7b7))
47+
- Added reference to Sample class ([77b684b](https://github.com/areias03/SPIREpy/commit/77b684b))
48+
- Added citation to README with syntax fixes ([567c92e](https://github.com/areias03/SPIREpy/commit/567c92e))
49+
- Improvements to README.md ([dac542a](https://github.com/areias03/SPIREpy/commit/dac542a))
50+
- Added badges to README.md ([15ac08b](https://github.com/areias03/SPIREpy/commit/15ac08b))
51+
52+
### Testing
53+
- Better unit and integration tests ([8d22854](https://github.com/areias03/SPIREpy/commit/8d22854))
54+
55+
## [0.1.0] - 2025-06-24
56+
57+
### Added
58+
- Initial release of SPIREpy
59+
- SPIRE wrapper and command-line tool for interacting with global microbiome data
60+
- Study class for managing study-level data
61+
- Sample class for managing sample-level data
62+
- Genome class for managing genome-level data
63+
- CLI interface with `spire` command
64+
- Support for downloading MAGs (Metagenome-Assembled Genomes)
65+
- AMR (Antimicrobial Resistance) annotations support
66+
- Disk caching for large SPIRE data
67+
- Comprehensive documentation with Sphinx
68+
- Unit and integration tests with pytest
69+
- Support for Python 3.9, 3.10, 3.11, 3.12, and 3.13
70+
71+
### Dependencies
72+
- polars
73+
- pandas
74+
- rich
75+
- joblib
76+
- platformdirs
77+
78+
[Unreleased]: https://github.com/areias03/SPIREpy/compare/v0.2.0...HEAD
79+
[0.2.0]: https://github.com/areias03/SPIREpy/compare/v0.1.0...v0.2.0
80+
[0.1.0]: https://github.com/areias03/SPIREpy/releases/tag/v0.1.0

0 commit comments

Comments
 (0)