Skip to content

Commit ef6170c

Browse files
committed
[DRAFT] Bump version number to 0.24.0 and add release notes
1 parent 3d58db1 commit ef6170c

2 files changed

Lines changed: 49 additions & 1 deletion

File tree

NEWS

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,54 @@
11
.. An online version of the release history can be found here:
22
.. http://pysam.readthedocs.io/en/latest/release.html
33

4+
Release 0.24.0
5+
==============
6+
7+
.. rubric:: xx December 2025
8+
9+
This pysam release wraps htslib and samtools version 1.22.1 and
10+
bcftools version 1.22 (PR #1343) and now requires Cython 3.
11+
HTSlib 1.22 and later contain significant operational changes which
12+
this pysam release inherits:
13+
14+
* The default output CRAM version is now 3.1.
15+
16+
* CRAM reference data is no longer fetched from EBI's server by default.
17+
Use the :envvar:`REF_CACHE` and :envvar:`REF_PATH` environment variables
18+
if necessary to set up an alternative source of CRAM reference data.
19+
20+
This release has been tested with Python versions 3.8 through 3.14, and wheels
21+
are available via PyPI_ for all of those Python versions. Wheels are built for
22+
macOS and Linux (manylinux_2_28 and musllinux_1_2) on both ARM and x86-64.
23+
24+
The final pysam release that supported Python 3.6 and 3.7 was v0.23.0.
25+
v0.24.x is expected to be the last release series supporting Python 3.8.
26+
27+
Bugs fixed:
28+
29+
* Removed :attr:`.AlignedSegment.modified_bases`'s limitation of only five
30+
modification types in MM/ML fields. (#1348, reported by Leszek Pryszcz)
31+
32+
* Suppressed TestBinaryCompatibility test cases on platforms where we
33+
have not calculated the expected sizes. Also fixed the capturing of
34+
:func:`pysam.samtools.calmd() <.samtools.command>` output, particularly
35+
on 32-bit i386. (#1367, reported by Étienne Mollier for Debian)
36+
37+
New functionality:
38+
39+
* Updated pysam/libchtslib.pxd declarations to the HTSlib 1.22.1 API.
40+
This is the first comprehensive update that these Cython HTSlib API
41+
declarations have received. (PR #1362)
42+
43+
Documentation improvements:
44+
45+
* New documentation for VariantRecordSample et al FIXME
46+
(PR #1358, PR #1359, PR #1361, thanks to Tim Dunn)
47+
48+
* Clarified :attr:`.AlignedSegment.query_alignment_length` et al
49+
behaviour for unmapped reads. (#1319, reported by Sam Chorlton)
50+
51+
452
Release 0.23.3
553
==============
654

pysam/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# pysam versioning information
2-
__version__ = "0.23.3"
2+
__version__ = "0.24.0a5"
33

44
__samtools_version__ = "1.22.1"
55
__bcftools_version__ = "1.22"

0 commit comments

Comments
 (0)