Skip to content

Commit 7eb89e7

Browse files
valeriupredoivaleriupredoi
authored
Merge pull request #90 from davidhassell/changelog
DOC: Add a Change Log
2 parents a2d8433 + 8d4804c commit 7eb89e7

File tree

4 files changed

+203
-1
lines changed

4 files changed

+203
-1
lines changed

‎Changelog.rst

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
Version 0.5.1
2+
-------------
3+
4+
**2025-08-21**
5+
6+
* Add a Changelog (https://github.com/NCAS-CMS/pyfive/issues/87 by
7+
`David Hassell <https://github.com/davidhassell>`_)
8+
* Improved documentation (https://github.com/NCAS-CMS/pyfive/pull/84
9+
by `Kai Mühlbauer <https://github.com/kmuehlbauer>`_)
10+
* When getting object by address, do not fully instantiate when
11+
iterating (https://github.com/NCAS-CMS/pyfive/pull/83 by `Kai
12+
Mühlbauer <https://github.com/kmuehlbauer>`_)
13+
* Add documentation for Pyfive
14+
(https://github.com/NCAS-CMS/pyfive/pull/81 by `Valeriu Predoi
15+
<https://github.com/valeriupredoi>`_)
16+
* Setup documentation builds on Readthedocs
17+
(https://github.com/NCAS-CMS/pyfive/pull/80 by `Valeriu Predoi
18+
<https://github.com/valeriupredoi>`_)
19+
20+
----
21+
22+
Version 0.5.0
23+
-------------
24+
25+
**2025-07-11**
26+
27+
* Add docs basic structure and ancillary files
28+
(https://github.com/NCAS-CMS/pyfive/pull/79 by `Valeriu Predoi
29+
<https://github.com/valeriupredoi>`_)
30+
* Test codecov CI
31+
(https://github.com/NCAS-CMS/pyfive/pull/77 by `Valeriu Predoi
32+
<https://github.com/valeriupredoi>`_)
33+
* Setup test coverage reporting via codecov reporting
34+
(https://github.com/NCAS-CMS/pyfive/pull/76 by `Valeriu Predoi
35+
<https://github.com/valeriupredoi>`_)
36+
* Changes to README to reflect new location and added a PR template
37+
(https://github.com/NCAS-CMS/pyfive/pull/74 by `Valeriu Predoi
38+
<https://github.com/valeriupredoi>`_)
39+
* PyPI package build GHA package builder
40+
(https://github.com/NCAS-CMS/pyfive/pull/73 by `Valeriu Predoi
41+
<https://github.com/valeriupredoi>`_)
42+
* Switch from master to main in Github Action test and add GHA PyPI
43+
package builder (https://github.com/NCAS-CMS/pyfive/pull/72 by
44+
`Valeriu Predoi <https://github.com/valeriupredoi>`_)
45+
* Modernize packaging (https://github.com/NCAS-CMS/pyfive/pull/69 by
46+
`Valeriu Predoi <https://github.com/valeriupredoi>`_)
47+
* Functionality enhancements to address lazy loading of chunked data,
48+
variable length strings, and other minor bug fixes
49+
(https://github.com/NCAS-CMS/pyfive/pull/68 by `Brian Lawrence
50+
<https://github.com/bnlawrence>`_)
51+
52+
----
53+
54+
Version 0.4.0
55+
-------------
56+
57+
**2024-10-29**
58+
59+
* Update README and setup for Python 3.8-3.13
60+
(https://github.com/NCAS-CMS/pyfive/pull/63 by `Jonathan Helmus
61+
<https://github.com/jjhelmus>`_)
62+
* Remove use of deprecated product function from numpy
63+
(https://github.com/NCAS-CMS/pyfive/pull/62 by `Jonathan Helmus
64+
<https://github.com/jjhelmus>`_)
65+
* Add Python 3.11 and 3.12 to test matrix in CI
66+
(https://github.com/NCAS-CMS/pyfive/pull/57 by `Jonathan Helmus
67+
<https://github.com/jjhelmus>`_)
68+
* Retrieve maxshape for Dataset
69+
(https://github.com/NCAS-CMS/pyfive/issues/50 by `Brian Maranville
70+
<https://github.com/bmaranville>`_)
71+
* Minimal change to avoid a numpy deprecation failure
72+
(https://github.com/NCAS-CMS/pyfive/pull/55 by `Brian Lawrence
73+
<https://github.com/bnlawrence>`_)
74+
* Use name as key for links if creation order is not specified
75+
(https://github.com/NCAS-CMS/pyfive/pull/54 by `Brian Maranville
76+
<https://github.com/bmaranville>`_)
77+
* Filter pipeline description v2
78+
(https://github.com/NCAS-CMS/pyfive/pull/52 by `Brian Maranville
79+
<https://github.com/bmaranville>`_)
80+
* B-tree v2 for links from LINK_INFO messages
81+
(https://github.com/NCAS-CMS/pyfive/issues/46 by `Wout De Nolf
82+
<https://github.com/woutdenolf>`_)
83+
* Fix test errors and warnings, drop support for Python 2.7
84+
(https://github.com/NCAS-CMS/pyfive/pull/44 by `Jonathan Helmus
85+
<https://github.com/jjhelmus>`_)
86+
* Adding an implementation of SoftLink
87+
(https://github.com/NCAS-CMS/pyfive/pull/43 by `Brian Maranville
88+
<https://github.com/bmaranville>`_)
89+
* Property offset is the same for layout_class 1 and 2
90+
(https://github.com/NCAS-CMS/pyfive/pull/42 by `Brian Maranville
91+
<https://github.com/bmaranville>`_)
92+
* Fix reading of superblock version 3
93+
(https://github.com/NCAS-CMS/pyfive/pull/40 by `Jonathan Helmus
94+
<https://github.com/jjhelmus>`_)
95+
* Support v3 superblocks, minor maintenance
96+
(https://github.com/NCAS-CMS/pyfive/pull/39 by `Jonathan Helmus
97+
<https://github.com/jjhelmus>`_)
98+
* Dataset.read_direct method
99+
(https://github.com/NCAS-CMS/pyfive/pull/37 by `Jonathan Helmus
100+
<https://github.com/jjhelmus>`_)
101+
* Dataset.astype and Dataset.value methods
102+
(https://github.com/NCAS-CMS/pyfive/pull/36 by `Jonathan Helmus
103+
<https://github.com/jjhelmus>`_)
104+
* Access datasets and groups by path
105+
(https://github.com/NCAS-CMS/pyfive/issues/15 by `Jonathan Helmus
106+
<https://github.com/jjhelmus>`_)
107+
108+
----
109+
110+
Version 0.3.0
111+
-------------
112+
113+
**2017-09-29**
114+
115+
* Split low_level module into multiple smaller modules and refactor
116+
(https://github.com/NCAS-CMS/pyfive/pull/34 by `Jonathan Helmus
117+
<https://github.com/jjhelmus>`_)
118+
* Unit tests for resizable datasets
119+
(https://github.com/NCAS-CMS/pyfive/pull/33 by `Jonathan Helmus
120+
<https://github.com/jjhelmus>`_)
121+
* Add File, Dataset, and Group __repr__ methods
122+
(https://github.com/NCAS-CMS/pyfive/pull/32 by `Jonathan Helmus
123+
<https://github.com/jjhelmus>`_)
124+
* Add visit and visititems methods to Group class
125+
(https://github.com/NCAS-CMS/pyfive/pull/31 by `Jonathan Helmus
126+
<https://github.com/jjhelmus>`_)
127+
* Support for reading dataset fillvalues
128+
(https://github.com/NCAS-CMS/pyfive/pull/29 by `Jonathan Helmus
129+
<https://github.com/jjhelmus>`_)
130+
* Support for reading and verifting fletcher32 checksums
131+
(https://github.com/NCAS-CMS/pyfive/pull/28 by `Jonathan Helmus
132+
<https://github.com/jjhelmus>`_)
133+
* Refactor datatype message funcs into class
134+
(https://github.com/NCAS-CMS/pyfive/pull/27 by `Jonathan Helmus
135+
<https://github.com/jjhelmus>`_)
136+
* Support for complex attribute datatypes
137+
(https://github.com/NCAS-CMS/pyfive/pull/26 by `Jonathan Helmus
138+
<https://github.com/jjhelmus>`_)
139+
* Refactor attribute value retrival
140+
(https://github.com/NCAS-CMS/pyfive/pull/25 by `Jonathan Helmus
141+
<https://github.com/jjhelmus>`_)
142+
* Dataset.ndim attribute (https://github.com/NCAS-CMS/pyfive/pull/24
143+
by `Jonathan Helmus <https://github.com/jjhelmus>`_)
144+
* Filename attribute set for file-like objects
145+
(https://github.com/NCAS-CMS/pyfive/pull/23 by `Jonathan Helmus
146+
<https://github.com/jjhelmus>`_)
147+
* File can be used as a context manager
148+
(https://github.com/NCAS-CMS/pyfive/pull/22 by `Jonathan Helmus
149+
<https://github.com/jjhelmus>`_)
150+
* Support for dimension labels and scales
151+
(https://github.com/NCAS-CMS/pyfive/issues/14 by `Jonathan Helmus
152+
<https://github.com/jjhelmus>`_)
153+
* Read variable length sequence attributes
154+
(https://github.com/NCAS-CMS/pyfive/pull/20 by `Jonathan Helmus
155+
<https://github.com/jjhelmus>`_)
156+
* Add Python 3.6 to travis matrix
157+
(https://github.com/NCAS-CMS/pyfive/pull/19 by `Jonathan Helmus
158+
<https://github.com/jjhelmus>`_)
159+
* Support for reading arrayed attributes
160+
(https://github.com/NCAS-CMS/pyfive/pull/18 by `Jonathan Helmus
161+
<https://github.com/jjhelmus>`_)
162+
* Support for Reference attribute types
163+
(https://github.com/NCAS-CMS/pyfive/pull/17 by `Jonathan Helmus
164+
<https://github.com/jjhelmus>`_)
165+
* Add support for v1 and v2 data objects
166+
(https://github.com/NCAS-CMS/pyfive/pull/16 by `synaptic
167+
<https://github.com/synaptic>`_)
168+
* Allow reading from BytesIO objects
169+
(https://github.com/NCAS-CMS/pyfive/pull/13 by `Jonathan Helmus
170+
<https://github.com/jjhelmus>`_)
171+
172+
----
173+
174+
Version 0.2.0
175+
-------------
176+
177+
**2016-09-10**
178+
179+
* Add chunks attribute to pyfive.Dataset class
180+
https://github.com/NCAS-CMS/pyfive/pull/11 by `Jonathan Helmus
181+
<https://github.com/jjhelmus>`_)
182+
* Reading of file-like objects with the tell method
183+
(https://github.com/NCAS-CMS/pyfive/issues/5 by `Jonathan Helmus
184+
<https://github.com/jjhelmus>`_)
185+
* Add support for gzip compression and shuffle filter
186+
(https://github.com/NCAS-CMS/pyfive/issues/4 by `Jonathan Helmus
187+
<https://github.com/jjhelmus>`_)
188+
189+
----
190+
191+
Version 0.1.0
192+
-------------
193+
194+
**2016-07-26**
195+
196+
* First release by `Jonathan Helmus <https://github.com/jjhelmus>`_
197+

‎doc/_sidebar.rst.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
API Reference <api_reference>
1111
Additional API Features <additional>
1212
Optimising Data Access Speed <optimising>
13+
Change Log <changelog>

‎doc/changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
**Change Log**
2+
==============
3+
4+
.. include:: ../Changelog.rst

‎doc/gensidebar.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ def _header(project, text):
6262
_write("pyfive", "API Reference", "api_reference")
6363
_write("pyfive", "Additional API Features", "additional")
6464
_write("pyfive", "Optimising Data Access Speed", "optimising")
65+
_write("pyfive", "Change Log", "changelog")
6566
# _write("pyfive", "Examples", "examples")
6667
# _write("pyfive", "Contributing to the community", "community/index")
6768
# _write("pyfive", "Utilities", "utils")
6869
# _write("pyfive", "API Reference", "api/pyfive")
6970
# _write("pyfive", "Frequently Asked Questions", "faq")
70-
# _write("pyfive", "Changelog", "changelog")
7171
_endl()
7272

7373
_write_if_changed("_sidebar.rst.inc", "\n".join(lines))

0 commit comments

Comments
 (0)