Skip to main content

Biip interprets the data in barcodes.

Project description

📦 Biip

Biip interprets the data in barcodes.

Tests Coverage Docs PyPI


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 and 02 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.
    • 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.
  • Restricted Circulation Numbers (RCN), 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 if py-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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

biip-0.3.0.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

biip-0.3.0-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file biip-0.3.0.tar.gz.

File metadata

  • Download URL: biip-0.3.0.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.5 Linux/5.3.0-1034-azure

File hashes

Hashes for biip-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3ae550f99a7839376502a9d7ab3543b5970da888e9a08301a466b0d7b32c0c93
MD5 bfcef1e24b4aa5a96fce43776bda97d6
BLAKE2b-256 146886c7b73c60b05a0d71475ced38b3f68cbaaa5c945c0de47cef9af0898813

See more details on using hashes here.

File details

Details for the file biip-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: biip-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 33.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.5 CPython/3.8.5 Linux/5.3.0-1034-azure

File hashes

Hashes for biip-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc5f9dc754f492a2d02081c58409c086eec4d8eb62b6383a1684ff5d8482a3ea
MD5 0e8a061c4fd44f59580bc76ff34d1142
BLAKE2b-256 5b530e61d5874d81412f04c93a5b391a416e4454bff84e343bdf5bdcc3c5031b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page