Releases: jodal/biip
Releases · jodal/biip
v3.5.1
v3.5.0
Breaking changes
- Drop support for Python 3.8 (PR: #326)
Changes
- Use
importlib.resources
to load bundled data files so that Biip can be installed as a zip file. (PR: #324, #327) - Update all bundled GS1 datasets. The GS1 Company prefixes is the only dataset with any changes.
- Test on Python 3.13
If you're using Biip, please add yourself to the list of users!
v3.4.0
Changes
- Accept redundant GS1 Message separator chars, both after fixed-length fields and at the end of the GS1 Message. The specification says that the separator characters "should not" be present in these locations, but doesn't forbid it. Multiple separator characters are also ignored. (Fixes: #176, PR: #304)
If you're using Biip, please add yourself to the list of users!
v3.3.0
Changes
- Add support for extracting dates and potentially datetimes from GS1 messages with AI 4324/4325/4326/7003/7006/7007/7011/8008. (PR: #301)
Fixes
- In the new GS1 AI dataset introduced in Biip 3.2.0, there are four AIs with optional pattern groups. When the value matches everything but the optional pattern group, the group's value becomes
None
. This caused Biip to crash when we tried building a string of the characters matching the pattern. (Fixes: #295, PR: #300)
If you're using Biip, please add yourself to the list of users!
v3.2.0
Changes
- Update all bundled GS1 datasets (PR: #292)
- GS1 Application Identifiers including many stricter regexp patterns
- GS1 Member Organization prefixes
- GS1 Company prefixes
Development environment
- Replace Black with ruff. (PR: #239)
If you're using Biip, please add yourself to the list of users!
v3.1.0
Breaking changes
- Drop support for Python 3.7, as it reached end-of-life this summer. (#207)
Changes
- Add Python 3.12 to the test matrix. (#232)
Development environment
- Type check with pyright in addition to mypy, and fix all typing issues indicated by pyright. (#186)
- Replace flake8 and all flake8 plugins with ruff. (#184)
If you're using Biip, please add yourself to the list of users!
v3.0.0
This release contains a couple of breaking changes, thus the version bump to 3.0.
Breaking changes
- Parsing and validation errors of GLNs, GTINs, and SSCCs nested inside GS1 Element Strings no longer raises
ParseError
. Instead, the exception message is exposed on theGS1ElementString
class as the new fieldsgln_error
,gtin_error
, andsscc_error
. This is a breaking change, but makes it possible to extract some information from GS1 Element Strings that are not entirely valid. (Fixes: #157, PR: #169) - Remove
RcnRegion.from_iso_3166_1_numeric_code()
class method which as been deprecated since Biip 2.2. (Fixes: #161, PR: #166)
GS1 Company Prefix support
- Add
GS1CompanyPrefix
class that can extract the company prefix from any GLN, GTIN, or SSCC. This is based on a data set from GS1 that is bundled with Biip, just like the GS1 Prefixes and GS1 Application Identifiers. The data set is preprocessed into a trie data structure, making company prefix length lookups fast. (Fixes: #160, PR: #172) - Add and set
company_prefix
fields on theGln
,Gtin
, andSssc
classes, based on the newGS1CompanyPrefix
class. (Fixes: #160, PR: #174) - Change
Sscc.as_hri()
to useGS1CompanyPrefix
to automatically group the company prefix and the serial when rendering SSCC's for human consumption. The existingcompany_prefix_length
parameter is now only used as an override in case you're rendering an SSCC whose company prefix is not included in the data set yet, or where you disagree with the data set. (Fixes: #160, PR: #173)
Other changes
- Add
rcn_verify_variable_measure
parameter to all functions and methods takingrcn_region
as a parameter. The parameter defaults toTrue
and the old behavior. By setting this parameter toFalse
, it is possible to parse and extract variable measure from RCNs that have separate check digit for the variable measure, but where the check digit is either incorrect or simply not in use as a check digit. This parameter only has any effect on RCN regions with formats including check digits, e.g. Great Britain and Germany. (PR: #171) - Update the bundled GS1 Application Identifier definitions. (PR: #164)
- Update the bundled GS1 Prefix definitions, and add script to automate future updates. (PR: #165)
- Add Python 3.11 to the test matrix, and updated development tooling. (PR: #163)
If you're using Biip, please add yourself to the list of users!
v2.3.0
Changes
- Add support for parsing GS1 Human Readable Interpretation (HRI) strings. HRI strings is the text typically printed below or next to GS1 element string barcodes. (PR: #155 and #156)
- Update the bundled GS1 Application Identifier definitions.
If you're using Biip, please add yourself to the list of users!
v2.2.4
v2.2.3
Bug fixes
- Fix crash in decimal parsing of GS1 Message. Some GS1 AI patterns allow a group to be empty. Biip tried to parse these as decimal numbers without checking if it had anything to parse first, causing a crash. (PR: #149)
If you're using Biip, please add yourself to the list of users!