Skip to main content

Biip interprets the data in barcodes.

Project description

📦 Biip

Biip interprets the data in barcodes.

Tests Docs Coverage 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.

For a quickstart guide and a complete API reference, see the documentation.

Installation

Biip requires Python 3.6 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]"

Project resources

Development status

All planned features have been implemented. Please open an issue if you have and barcode parsing related needs that are not covered.

Features

  • GS1 (multiple Element Strings with Application Identifiers)
    • Recognize all specified Application Identifiers.
    • Recognize allocating GS1 Member Organization from the GS1 Company Prefix.
    • 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.
  • 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 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.
    • Encode for human consumption, with the logical groups separated by whitespace.
  • Symbology Identifers, e.g. ]EO
    • Recognize all specified Symbology Identifier code characters.
    • Strip Symbology Identifers before parsing the remainder.
    • Use Symbology Identifers when automatically selecting what parser to use.

License

Biip is copyright 2020-2021 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-1.0.0.tar.gz (35.7 kB view details)

Uploaded Source

Built Distribution

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

biip-1.0.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: biip-1.0.0.tar.gz
  • Upload date:
  • Size: 35.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.4 Linux/5.4.0-1043-azure

File hashes

Hashes for biip-1.0.0.tar.gz
Algorithm Hash digest
SHA256 27b348be951bf22114a67b5ff21af3bddc1848116b08946d9432e98aea98355e
MD5 93f89d0de731235539877eedbbab78b1
BLAKE2b-256 04caf9495b96081045e64abe41bd1dcfc6aceae5f4bc6276a392157b1ddc2578

See more details on using hashes here.

File details

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

File metadata

  • Download URL: biip-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.4 Linux/5.4.0-1043-azure

File hashes

Hashes for biip-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75e63b706c6b66959bf3b6ed95bbd27fc50feb69d23073a97567ac2451f1ba67
MD5 3d347b8853e4398c8e5db6048b461e02
BLAKE2b-256 28e5992b0e1621c657573e3418fa5420617fd2cb017ef443c8ab9a1f94608d6b

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