VerificaC19 SDK for Python
Project description
VerificaC19 Python SDK
🐍 VerificaC19 SDK implementation for Python.
Requirements
- Python version >= 3.7
Make sure zbar
is installed in your system. Source.
- For Mac OS X, it can be installed via
brew install zbar
- Debian systems via
apt install libzbar0
- Fedora / Red Hat
dnf install zbar
Install
pip install verificac19
Usage
Download and cache rules and DSCs
You can download and cache rules and DSCs using service
.
from verificac19 import service
service.update_all()
update_all
may rise VerificaC19Error
from verificac19.exceptions import VerificaC19Error
⚠️ By default rules and DSCs will be cached in local folder,
to change it please set VC19_CACHE_FOLDER
env variable.
Verify a DCC
You can verify a DCC using verifier
. You can verify a DCC using
verify_image
for images and verify_raw
for raw data.
from verificac19 import verifier
result = verifier.verify_image("my_dcc.png")
result = verifier.verify_raw("HC1:GH.....1GH")
verify_image
and verify_raw
return a dictionary containing person
name,
date_of_birth
, code
and a message
alongside the result
{
'code': verifier.Codes.NOT_VALID,
'result': False,
'message': 'Certificate is not valid',
'person': 'Sčasný Svätozár',
'date_of_birth': '1984-09-27'
}
you can compare the resulting code
with verifier.Codes
values
Code | Description | |
---|---|---|
✅ | VALID | Certificate is valid |
❌ | NOT_VALID | Certificate is not valid |
❌ | NOT_VALID_YET | Certificate is not valid yet |
❌ | NOT_EU_DCC | Certificate is not an EU DCC |
for example
result = verifier.verify_image("my_dcc.png")
assert result['code'] == verifier.Codes.NOT_VALID
⚠️ verify_image
and verify_raw
may rise VerificaC19Error
in case you cache
is not initialized. You need to call service.update_all()
at least once!
Verification mode
If you want to change verification mode and verify whether a certificate is a
Super Green Pass or not, you need to pass verifier.Mode.SUPER_DGP
to
verify_image
and verify_raw
methods.
from verificac19 import verifier
result = verifier.verify_image("my_dcc.png", verifier.Mode.SUPER_DGP)
verifier.Mode
exposes 2 possible values
Code | Description |
---|---|
NORMAL_DGP | Normal verification (default value ) |
SUPER_DGP | Super Green Pass verification |
Super Green Pass, which will come into force from 6 December to 15 January 2021, will be a certificate valid only for people who have been vaccinated against or who have recovered from Covid19, and will prevent all the others from entering bars, restaurants, cinemas, gyms, theatres, discos and stadiums.
Development
Install dev dependencies
pip install -r requirements-dev.txt
Make sure zbar
is installed in your system. Source.
- For Mac OS X, it can be installed via
brew install zbar
- Debian systems via
apt install libzbar0
- Fedora / Red Hat
dnf install zbar
Run tests
make test
Run examples
python -m examples.<example_name>
Authors
Copyright (c) 2021 - Lotrèk Digital Agency
Contributors
Thank you to everyone involved for improving this project, day by day.
License
This library is available under the MIT license.
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
Built Distribution
File details
Details for the file verificac19-1.0.4.tar.gz
.
File metadata
- Download URL: verificac19-1.0.4.tar.gz
- Upload date:
- Size: 10.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8db4509d78f215202b794877621fe6af88d80b27686424af77c360070a575b66 |
|
MD5 | 28a7c5b4a7c7f584ebb91ac77116ac1a |
|
BLAKE2b-256 | 00cfe48ac5f1b56595046ef611748d306d039c1669b2a8340370fd929270db90 |
File details
Details for the file verificac19-1.0.4-py2.py3-none-any.whl
.
File metadata
- Download URL: verificac19-1.0.4-py2.py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 323a1c9a805b350fa67f20af6ae09c17db2c91a89092f90124124f59ea96f7e9 |
|
MD5 | ae64d447f5b9b621907ffcdee61d5af8 |
|
BLAKE2b-256 | 1df48cbfb11a2f6bd0d3a944fdab889422c63e69e7b457ac7d15efddebeb63c0 |