aztecdecoder 1.1.0__py3-none-any.whl

aztecdecoder-1.1.0.dist-info/METADATA

@@ -0,0 +1,134 @@
+Metadata-Version: 2.4
+Name: aztecdecoder
+Version: 1.1.0
+Summary: Biblioteka programistyczna pozwalająca na dekodowanie danych z dowodów rejestracyjnych pojazdów samochodowych zapisanych w formie kodu AZTEC 2D.
+Author-email: Bartosz Wójcik <support@pelock.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://www.pelock.com/pl/produkty/dekoder-aztec
+Project-URL: Source, https://github.com/PELock/Dekoder-AZTEC-2D-Python
+Project-URL: Bug Tracker, https://github.com/PELock/Dekoder-AZTEC-2D-Python/issues
+Keywords: aztec2d,aztec-decoder,aztec,vin,vehicle
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Natural Language :: Polish
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28.0
+
+# Dekoder Kodu AZTEC 2D z Dowodu Rejestracyjnego dla Python
+
+[![PyPI](https://img.shields.io/pypi/v/aztecdecoder.svg)](https://pypi.org/project/aztecdecoder/)
+[![Python](https://img.shields.io/pypi/pyversions/aztecdecoder.svg)](https://pypi.org/project/aztecdecoder/)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Oferujemy Państwu usługę Web API pozwalającą zdekodować dane z kodu AZTEC 2D zapisanego w dowodach rejestracyjnych pojazdów samochodowych.
+
+![Kod AZTEC 2D zapisany w formie obrazkowej w dowodzie rejestracyjnym pojazdu](https://www.pelock.com/img/pl/produkty/dekoder-aztec/dowod-rejestracyjny-kod-aztec-2d.jpg)
+
+Nasza biblioteka dekoduje dane z dowodu rejestracyjnego, zapisane w postaci kodu obrazkowego tzw. kod aztec. Dekodowane są wszystkie wymienione pola w dowodzie rejestracyjnym pojazdu.
+
+https://www.pelock.com/pl/produkty/dekoder-aztec
+
+## Gdzie znajdzie zastosowanie Dekoder AZTec?
+
+Dekoder AZTec może przydać się firmom i instytucjom, które pragną zautomatyzować proces ręcznego wprowadzania danych z dowodów rejestracyjnych i zastąpić go poprzez wykorzystanie naszej biblioteki programistycznej, która potrafi rozpoznać i rozkodowac kody AZTEC 2D bezpośrednio ze zdjęć dowodów rejestracyjnych lub zeskanowanych już kodów (wykorzystując skaner QR / AZTEC 2D).
+
+## Dostępne edycje programistyczne
+
+Dekoder AZTec dostepny jest w trzech edycjach. Każda wersja posiada inne cechy i inne możliwości dekodowania. Wersja oparta o Web API jako jedyna posiada możliwość rozpoznawania i dekodowania danych bezpośrednio ze zdjęć i obrazków. Pozostałe wersje do dekodowania wymagają już odczytanego kodu w postaci tekstu (np. ze skanera).
+
+![Dekodowanie kodu AZTEC 2D do formatu JSON](https://www.pelock.com/img/pl/produkty/dekoder-aztec/dekodowanie-kodu-aztec-2d-do-json.png)
+
+### Wersja Web API
+
+Jest to najbardziej zaawansowana edycja Dekodera AZTec, ponieważ umożliwia precyzyjne rozpoznawanie i dekodowanie kodów AZTEC 2D bezpośrednio ze zdjęć oraz obrazków zapisanych w formatach PNG lub JPG.
+
+Algorytm rozpoznawania obrazu należy do naszej firmy, jest to innowacyjne rozwiązanie rozwijane od podstaw przez prawie rok czasu.
+
+Rozumiemy potrzeby naszych klientów oraz problemy wynikające z rozpoznawnia rzeczywistych zdjęć kodów AZTEC 2D znajdujących się w dowodach rejestracyjnych, które nie zawsze są idealnie wykonane, czy to ze względu na rodzaj aparatu, kąta wykonania zdjęcia, refleksów czy słabej rozdzielczości.
+
+Przy tworzeniu naszego rozwiązania wzieliśmy wszystkie te czynniki pod uwagę i w efekcie nasz algorytm radzi sobie znakomicie z rozpoznawaniem kodów AZTEC 2D ze zdjęć z wszelkiego rodzaju zniekształceniami, uszkodzeniami i niedoskonałościami. Znacznie przewyższa pod względem funkcjonowania dostępne na rynku biblioteki rozpoznawnia kodów AZTEC 2D takie jak np. ZXing.
+
+### Gotowe paczki dla różnych języków programowania
+
+Dla ułatwienia szybkiego wdrożenia, paczki instalacyjne Dekodera AZTec zostały wgrane na repozytoria dla kilku popularnych języków programowania, a dodatkowo ich kody źródłowe zostały opublikowane na GitHubie:
+
+| Repozytorium | Język | Instalacja | Paczka | GitHub |
+| ------------ | ----- | ---------- | ------ | ------ |
+| ![Centralne Repozytorium Maven](https://www.pelock.com/img/logos/repo-maven.png) | Java | Dodaj wpis do pliku `pom.xml`<br />`<dependency>`<br />`  <groupId>com.pelock</groupId>`<br />`  <artifactId>AZTecDecoder</artifactId>`<br />`  <version>1.0.0</version>`<br />`</dependency>` | [Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.pelock%22) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-Java)
+| ![Repozytorium NPM](https://www.pelock.com//img/logos/repo-npm.png) | JavaScript, TypeScript | `npm install aztec-decoder` | [NPM](https://www.npmjs.com/package/aztec-decoder) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-JavaScript)
+| ![Repozytorium NuGet](https://www.pelock.com/img/logos/repo-nuget.png) | C#, VB.NET, .NET | `PM> Install-Package AZTecDecoder` | [NuGet](https://www.nuget.org/packages/AZTecDecoder/) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-CSharp)
+| ![Repozytorium Packagist dla Composer](https://www.pelock.com/img/logos/repo-packagist-composer.png) | PHP | Dodaj do sekcji `require` w twoim pliku `composer.json` linijkę `"pelock/aztec-decoder": "*"` | [Packagist](https://packagist.org/packages/pelock/aztec-decoder) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-PHP)
+| ![Repozytorium PyPI dla Python](https://www.pelock.com/img/logos/repo-pypi.png) | Python | `pip install aztecdecoder==1.1.0` | [PyPi](https://pypi.org/project/aztecdecoder/) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-Python)
+| ![Repozytorium Cargo dla Rust](https://www.pelock.com/img/logos/repo-cargo.png) | Rust | `cargo add aztec-decoder` | [Crates.io](https://crates.io/crates/aztec-decoder) | [Źródła](https://github.com/PELock/Dekoder-AZTEC-2D-Rust)
+
+#### Instalacja dla Pythona i PyPi
+
+Preferowany sposób instalacji biblioteki poprzez [pip](https://pypi.python.org/pypi/pip).
+
+Uruchom:
+
+```
+pip install aztecdecoder
+```
+
+Paczka dostępna na https://pypi.python.org/pypi/aztecdecoder/
+
+#### Użycie dekodera AZTEC 2D w Python v3
+
+```python
+#
+#  załącz moduł dekodera
+#
+from pelock import aztecdecoder
+from pprint import pprint
+
+#
+# utwórz klasę dekodera (używamy naszego klucza licencyjnego do inicjalizacji)
+#
+aztec_decoder = aztecdecoder.AZTecDecoder("ABCD-ABCD-ABCD-ABCD")
+
+#
+# 1. Dekoduj dane bezpośrednio z pliku graficznego, zwróć wynik jako rozkodowaną tablicę elementów JSON
+#
+decoded_array = aztec_decoder.decode_image_from_file("C:\\sciezka\\zdjecie-dowodu.jpg")
+
+# czy udało się zdekodować dane?
+if decoded_array and "Status" in decoded_array:
+
+    # wyświetl rozkodowane dane (są zapisane jako rozkodowana tablica elementów JSON)
+    pprint(decoded_array)
+
+#
+# 2. Dekoduj dane bezpośrednio z pliku graficznego i zwróć wynik jako rozkodowaną tablicę elementów JSON
+#
+decoded_json = aztec_decoder.decode_image_from_file("C:\\sciezka\\zdjecie-kodu-aztec-2d.png")
+
+if decoded_json:
+
+    pprint(decoded_json)
+
+#
+# 3. Dekoduj dane z odczytanego już ciągu znaków (np. wykorzystując skaner ręczny)
+#
+# zakodowane dane z dowodu rejestracyjnego
+value = "ggMAANtYAAJD...";
+
+decoded_text = aztec_decoder.decode_text(value)
+
+if decoded_text:
+
+    pprint(decoded_text)
+```
+
+---
+
+Bartosz Wójcik | [PELock](https://www.pelock.com) | [Twitter/X](https://x.com/PELock) | [Dekoder AZTec](https://www.dekoderaztec.pl)
+

aztecdecoder-1.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pelock/__init__.py,sha256=fRvRZqqrvhX9C4nHggjc4uoiyL7x1E16BIEj6cgKdkY,167
+pelock/aztecdecoder.py,sha256=wu9zbUi-q3-X1xw-Bdrf7ro_ki4DUcmVKfxPY7uk-vg,4040
+aztecdecoder-1.1.0.dist-info/METADATA,sha256=vCZzFIupwZ7dM1hgG-1aTvjfprzMSPloHE8DJbvs4hk,7996
+aztecdecoder-1.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+aztecdecoder-1.1.0.dist-info/top_level.txt,sha256=t59zeOfBWexYbGMTprjXWY6YSjyfeJrHAzerFXW0Eyo,7
+aztecdecoder-1.1.0.dist-info/RECORD,,

aztecdecoder-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aztecdecoder-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pelock

pelock/__init__.py

@@ -0,0 +1,7 @@
+"""PELock AZTEC 2D decoder (Web API client)."""
+
+from pelock.aztecdecoder import AZTecDecoder
+
+__version__ = "1.1.0"
+
+__all__ = ["AZTecDecoder", "__version__"]

pelock/aztecdecoder.py

@@ -0,0 +1,136 @@
+#!/usr/bin/env python
+
+#
+# Dekoder kodow AZTEC 2D z dowodow rejestracyjnych interfejs Web API
+#
+# Wersja         : AZTecDecoder v1.1.0
+# Jezyk          : Python v3
+# Zaleznosci     : requests (https://pypi.python.org/pypi/requests/)
+# Autor          : Bartosz Wójcik (support@pelock.com)
+# Strona domowa  : https://www.dekoderaztec.pl | https://www.pelock.com
+#
+
+import json
+from typing import Any, Dict, Optional
+
+# wymagany pakiet requests - instalacja komenda "pip install requests"
+import requests
+
+class AZTecDecoder(object):
+
+    #
+    # @var string domyslna koncowka WebApi
+    #
+    API_URL = "https://www.pelock.com/api/aztec-decoder/v1"
+
+    #
+    # @var string klucz WebApi do uslugi AZTecDecoder
+    #
+    _api_key = ""
+
+    def __init__(self, api_key: str, timeout: float = 120.0) -> None:
+        """Inicjalizacja klasy AZTecDecoder
+
+        :param api_key: Klucz do uslugi WebApi
+        :param timeout: Limit czasu zapytania HTTP w sekundach (domyslnie 120)
+        """
+
+        self._api_key = api_key
+        self._timeout = timeout
+
+    def decode_text(self, text: str) -> Optional[Any]:
+        """Dekodowanie zaszyfrowanej wartosci tekstowej do
+           wyjsciowej tablicy w formacie JSON.
+
+        :param text: Odczytana wartosc z kodem AZTEC2D w formie ASCII
+        :return Rozkodowana tablica elementow JSON lub None jesli blad
+        :rtype object
+        """
+
+        # parametry
+        params = {"command": "decode-text", "text": text}
+
+        return self.post_request(params)
+
+    def decode_text_from_file(self, text_file_path: str) -> Optional[Any]:
+        """Dekodowanie zaszyfrowanej wartosci tekstowej
+           ze wskaznego pliku do wyjsciowej tablicy z
+           formatu JSON.
+
+        :param text_file_path: Sciezka do pliku z odczytana wartoscia kodu AZTEC2D
+        :return Rozkodowana tablica elementow JSON lub None jesli blad
+        :rtype object
+        """
+
+        with open(text_file_path, 'r') as f:
+
+            text = f.read()
+
+            if text:
+
+                return self.decode_text(text)
+
+        return None
+
+    def decode_image_from_file(self, image_file_path: str) -> Optional[Any]:
+        """Dekodowanie zaszyfrowanej wartosci zakodowanej
+           w obrazku PNG lub JPG/JPEG do wyjsciowej tablicy
+           w formacie JSON.
+
+        :param image_file_path: Sciezka do obrazka z kodem AZTEC2D
+        :return Rozkodowana tablica elementow JSON lub None jesli blad
+        :rtype object
+        """
+        # parametry
+        params = {"command": "decode-image", "image": image_file_path}
+
+        return self.post_request(params)
+
+    def post_request(self, params_array: Dict[str, Any]) -> Optional[Any]:
+        """Wysyla zapytanie POST do serwera WebApi
+
+        :param params_array: Tablica z parametrami dla zapytania POST
+        :return: Rozkodowana tablica elementow JSON lub None jesli blad
+        :rtype: object
+        """
+
+        # czy jest ustawiony klucz Web API?
+        if not self._api_key:
+
+            return None
+
+        # do parametrow dodaj klucz WebAPI
+        params_array["key"] = self._api_key
+
+        # ustaw poprawnie element z plikiem
+        if "image" in params_array:
+
+            image_path = params_array.pop("image", None)
+            with open(image_path, "rb") as image_file:
+                files = {"image": image_file}
+                response = requests.post(
+                    self.API_URL,
+                    files=files,
+                    data=params_array,
+                    timeout=self._timeout,
+                )
+
+        else:
+
+            response = requests.post(
+                self.API_URL, data=params_array, timeout=self._timeout
+            )
+
+        if response and response.ok:
+
+            try:
+
+                return json.loads(response.text)
+
+            except json.JSONDecodeError:
+
+                return None
+
+        else:
+
+            return None