Biip interprets the data in barcodes.
Project description
📦 Biip
Biip interprets the data in barcodes.
Biip is a Python library for making sense of the data in barcodes.
The library can interpret the following formats:
-
GTIN-8, GTIN-12, GTIN-13, and GTIN-14 numbers, commonly found in EAN-8, EAN-13, UPC-A, UPC-E, and ITF-14 barcodes.
-
GS1 AI element strings, commonly found in GS1-128 barcodes.
Features
- GS1 (multiple Element Strings with Application Identifiers)
- Parse fixed-length Element Strings.
- Parse variable-length Element Strings.
- Support configuring the separation character.
- Parse AI
00
as SSCC. - Parse AI
01
and02
as GTIN. - Parse dates into
datetime.date
values.- Interpret the year to be within -49/+50 years from today.
- Interpret dates with day "00" as the last day of the month.
- Parse variable measurement fields into
Decimal
values. - Parse discount percentage into
Decimal
values. - Parse amounts into
Decimal
values.- Additionally, if py-moneyed is installed,
parse amounts with currency into
Money
values.
- Additionally, if py-moneyed is installed,
parse amounts with currency into
- Encode as Human Readable Interpretation (HRI), e.g. with parenthesis around the AI numbers.
- Easy lookup of parsed Element Strings by:
- Application Identifier (AI) prefix
- Part of AI's data title
- GTIN (Global Trade Item Number)
- Parse GTIN-8, e.g. from EAN-8 barcodes.
- Parse GTIN-12, e.g. from UPC-A and UPC-E barcodes.
- Parse GTIN-13, e.g. from EAN-13 barcodes.
- Parse GTIN-14, e.g. from ITF-14 and GS1-128 barcodes.
- Extract and validate check digit.
- Extract GS1 Prefix.
- Extract packaging level digit from GTIN-14.
- Encode GTIN-8 as GTIN-12/13/14.
- Encode GTIN-12 as GTIN-13/14.
- Encode GTIN-13 as GTIN-14.
- RCN (Restricted Circulation Numbers), a subset of GTINs
- Classification of RCN usage to either a geographical region or a company.
- Parsing of variable measurements (price/weight) into
Decimal
values. - Parsing of price values into
Money
values ifpy-moneyed
is installed and the region's RCN parsing rules specifies a currency. - Baltics: Parsing of weight.
- Great Britain: Parsing of price, including validation of price check digit.
- Norway: Parsing of weight and price.
- Sweden: Parsing of weight and price.
- Encode RCN with the variable measure part zeroed out, to help looking up the correct trade item.
- SSCC (Serial Shipping Container Code)
- Validate check digit.
- Extract GS1 Company Prefix, if possible due to varying field length.
- Extract serial reference, if possible due to varying field length.
- Symbol IDs, e.g.
]EO
- Use Symbol IDs when automatically selecting what parser to use.
- Strip Symbol IDs before parsing the remainder.
Installation
Biip requires Python 3.7 or newer.
Biip is available from PyPI:
python3 -m pip install biip
Optionally, with the help of py-moneyed
, Biip can convert amounts with
currency information to moneyed.Money
objects.
To install Biip with py-moneyed
, run:
python3 -m pip install "biip[money]"
Usage
This project is still in its infancy. However, some documentation already exists.
License
Biip is copyright 2020 Stein Magnus Jodal and contributors. Biip is licensed under the Apache License, Version 2.0.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.