v1.0.2 (2022-07-26)¶
Backwards Incompatible Changes¶
Dropped support for Python 3.6. (#73)
Features¶
Updated “SIS Crate” digitizers mapper (
HDFMapDigiSISCrate) so the analog-digital-converters can have enabled/active boards without enabled/active channels. (#61)Updated
HDFMapControl6Kso the identification and mapping of probe configurations uses the combination of the receptacle number and probe name as an unique id, opposed to just the probe name. (#63)Created helper function
bapsflib.utils._bytes_to_strto convert byte literals to utf-8 strings. (#64)Made indexing of datasets more robust in a few locations in anticipation of allowing
h5py >= 3.0, and thus accounting forh5py’s change in indexing behavior. (#65)
Documentation Improvements¶
Incorporated towncrier and sphinx-changelog for better change log tracking and continuous change log rending in the documentation. (#56)
Trivial/Internal Changes¶
Refactored
bapsflibmodule imports to be consistent with the style enforced byisort. (#66)Refactored
bapsflibusingblack==21.7b0styling formatter, and converted many string concatenations and format strings into f-strings . (#67)Added
.git-blame-ignore-revsto package sogit blameignores the major refactoring commits fromisortPR #66 andblackPR #67. (#68)Converted all remaining relative imports to absolute imports. (#83)
Package Management¶
Added GitHub Action
check_pr_changelog.ymlto check for valid change log entries on a pull request. (#58)Added GitHub Action
tests.ymlfor testing of pushes tomaster, version tags, pull requests, and cron jobs every Sunday at 3:13 am PT. Tests are setup to run on the latest versions of ubuntu, MacOS, and Windows. Tests are setup to run on Python 3.6, 3.7, and 3.8. Tests also run on min versions ofh5py(v2.8.0) andnumpy(v1.14). (#58)Added
isortconfiguration topyproject.toml. (#66)Created GitHub Action
linters.ymlwith the isort/isort-action to check that module imports are properly styled. (#66)Added
black==21.7b0to the “extras” dependencies and add its configuration topyproject.toml. (#67)Added to GitHub Action
linters.yml`the psf/black action to check that new code is formatted properly. (#67)Deleted
pep8speaks.ymland disconnect CI from repo since package is adoptingblackand associated GitHub Action. (#67)Added a GitHub Dependabot to keep versions of GitHub Actions up to date. (#72)
Reworked testing GitHub Action workflow such that: two base tests are initially run; if the base tests pass, then the full matrix of tests are run; and if the full matrix of tests passes, then the tests on minimum versions are run. (#72)
Updated GitHub Actions for linters
isortandblacksuch that the associated package versions used are taken frombapsflib’s requirements files. (#72)Set package dependency
coverage[toml] >= 4.5.1. The[toml]option allows for the coverage configuration to be defined inpyproject.toml, andv4.5.1is the first release with this functionality. (#74)Moved the coverage configuration from
.coveragerctopyproject.toml. (#74)Removed
setuptoolsandsetuptools_scmfromsetup.cfginstall dependencies since they are already listed as build dependencies inpyproject.toml. (#74)Exposed
requirements/build.txtintorequirements/install.txtsincesetuptoolsandsetuptools_scmare both build and install dependencies. (#74)Added workflow
python-publish.ymlto GitHub Actions that builds and publishes a release to PyPI when using GitHub’s Releases functionality. (#84)Added an
import bapsflibtest to thetest.ymlGitHub Action workflow. (#85)Added a package build and install test to the
test.ymlGitHub Action workflow. (#85)Added a codespell test to the
linters.ymlGitHub Action workflow. (#86)