Skip to content

Commit 53ee48c

Browse files
authored
Maintenance and python 3.9 drop (#67)
1 parent 0ab5792 commit 53ee48c

File tree

4 files changed

+33
-11
lines changed

4 files changed

+33
-11
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# SDDS-Files Changelog
22

3+
## Version 0.4.3
4+
5+
- Dropped support for `Python 3.9`.
6+
37
## Version 0.4.2
48

59
- Using `format_string` instead of `format` in `Definition` class.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
# SDDS
2-
[![Cron Testing](https://github.com/pylhc/sdds/workflows/Cron%20Testing/badge.svg)](https://github.com/pylhc/sdds/actions?query=workflow%3A%22Cron+Testing%22)
3-
[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
4-
[![Code Climate maintainability (percentage)](https://img.shields.io/codeclimate/maintainability-percentage/pylhc/sdds.svg?style=popout)](https://codeclimate.com/github/pylhc/sdds)
5-
<!-- [![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/) -->
2+
3+
[![Tests](https://github.com/pylhc/sdds/actions/workflows/coverage.yml/badge.svg?branch=master)](https://github.com/pylhc/sdds/actions/workflows/coverage.yml)
4+
[![GitHub last commit](https://img.shields.io/github/last-commit/pylhc/sdds.svg?style=popout)](https://github.com/pylhc/sdds/)
65
[![PyPI Version](https://img.shields.io/pypi/v/sdds?label=PyPI&logo=pypi)](https://pypi.org/project/sdds/)
76
[![GitHub release](https://img.shields.io/github/v/release/pylhc/sdds?logo=github)](https://github.com/pylhc/sdds/)
87
[![Conda-forge Version](https://img.shields.io/conda/vn/conda-forge/sdds?color=orange&logo=anaconda)](https://anaconda.org/conda-forge/sdds)
98
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5705820.svg)](https://doi.org/10.5281/zenodo.5705820)
109

1110
This package provides reading and writing functionality for [**self describing data sets (sdds)**](https://ops.aps.anl.gov/SDDSIntroTalk/slides.html) files.
12-
On the python side, the data is stored in a class structure with attributes corresponding to the sdds-format itself (see [sdds-format](https://ops.aps.anl.gov/manuals/SDDStoolkit/SDDStoolkitsu2.html)).
11+
On the python side, the data is stored in a class structure with attributes corresponding to the sdds-format itself (see [sdds-format](https://ops.aps.anl.gov/manuals/SDDStoolkit/SDDStoolkitsu2.html)).
1312

1413
See the [API documentation](https://pylhc.github.io/sdds/) for details.
1514

1615
## Installing
1716

1817
Installation is easily done via `pip`:
18+
1919
```bash
2020
python -m pip install sdds
2121
```
2222

2323
One can also install in a `conda` environment via the `conda-forge` channel with:
24+
2425
```bash
2526
conda install -c conda-forge sdds
2627
```
@@ -40,7 +41,7 @@ By default the endianness (byte order) of the file is determined either by
4041
a comment `!# little-endian` or `!# big-endian` in the header of the file.
4142
If this comment is not found, the endianness of the running machine is assumed.
4243

43-
One can force a certain kind of endianness to the reader by supplying it to
44+
One can force a certain kind of endianness to the reader by supplying it to
4445
the read function:
4546

4647
```python
@@ -50,9 +51,9 @@ sdds_data = sdds.read("path_to_input_with_big_endian.sdds", endianness="big")
5051
sdds_data = sdds.read("path_to_input_with_little_endian.sdds", endianness="little")
5152
```
5253

53-
Be aware that `sdds.write` will always write the file in big-endian order and
54+
Be aware that `sdds.write` will always write the file in big-endian order and
5455
will also leave a comment in the file, so that the reader can determine the
55-
endianness and there is no need to supply it when reading
56+
endianness and there is no need to supply it when reading
5657
a file written by this package.
5758

5859
## Known Issues

pyproject.toml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ authors = [
2424
]
2525
license = "MIT"
2626
dynamic = ["version"]
27-
requires-python = ">=3.9"
27+
requires-python = ">=3.10"
2828

2929
keywords = [
3030
"SDDS",
@@ -36,10 +36,11 @@ classifiers = [
3636
"Natural Language :: English",
3737
"Operating System :: OS Independent",
3838
"Programming Language :: Python :: 3 :: Only",
39-
"Programming Language :: Python :: 3.9",
4039
"Programming Language :: Python :: 3.10",
4140
"Programming Language :: Python :: 3.11",
4241
"Programming Language :: Python :: 3.12",
42+
"Programming Language :: Python :: 3.13",
43+
"Programming Language :: Python :: 3.14",
4344
"Programming Language :: Python :: Implementation :: CPython",
4445
"Topic :: Scientific/Engineering",
4546
"Topic :: Software Development :: Libraries :: Python Modules",
@@ -71,6 +72,22 @@ repository = "https://github.com/pylhc/sdds"
7172
documentation = "https://pylhc.github.io/sdds/"
7273
changelog = "https://github.com/pylhc/sdds/blob/master/CHANGELOG.md"
7374

75+
# ----- Testing ----- #
76+
77+
[tool.pytest.ini_options]
78+
addopts = [
79+
"--import-mode=importlib",
80+
]
81+
82+
[tool.coverage.run]
83+
relative_files = true
84+
85+
[tool.coverage.report]
86+
exclude_also = [
87+
"if TYPE_CHECKING:", # do not count type checking imports (ignored at runtime) for coverage
88+
"except ImportError:", # do not count missing optional dependencies set to None, we monkeypatch and test that
89+
]
90+
7491
# ----- Dev Tools Configuration ----- #
7592

7693
[tool.ruff]

sdds/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
__title__ = "sdds"
88
__description__ = "SDDS file handling."
99
__url__ = "https://github.com/pylhc/sdds"
10-
__version__ = "0.4.2"
10+
__version__ = "0.4.3"
1111
__author__ = "pylhc"
1212
__author_email__ = "[email protected]"
1313
__license__ = "MIT"

0 commit comments

Comments
 (0)