Xebus ID Card Generator

Xebus ID Card Generator is a Command-Line Interface (CLI) written in Python used to generate JPEG images of Xebus ID cards.

This script generates images which size has the same portrait ratio as ISO/IEC 7810 Identification cards ID-1 (3 3⁄8 in × 2 1⁄8 in, 54mm x 85.6mm).

Installation

Xebus ID Card Generator can be easily installed with [pipenv]cod(https://github.com/pypa/pipenv):

$ pipenv --python 3.8 shell
$ pipenv install xebus-id-card-image-generator

Note: As of October 2020, the Python Image Library (PIL) is not yet compatible with Python 3.9.

Execution

$ ./bin/xidgen --help
usage: xidgen [-h] [-c TYPE] -f FILE [-d CHAR] [-q CHAR] [-e CHAR]
              [-s GEOMETRY] [-p SIZE] --header-file FILE [--font-name NAME]

Xebus ID Card Images Generator

optional arguments:
  -h, --help            show this help message and exit
  -c TYPE, --card-type TYPE
                        specify the type of ID cards to generate (driver,
                        guardian, securityguard, student)
  -f FILE, --csv-file FILE
                        specify the absolute path and name of the CSV file
                        containing the information of ID cards to generate
  -d CHAR, --delimiter CHAR
                        specify the character used to separate each field
                        (default to character [,])
  -q CHAR, --quotechar CHAR
                        specify the character used to surround fields that
                        contain the delimiter character (default to character
                        ["]).
  -e CHAR, --escapechar CHAR
                        specify the character used to escape the delimiter
                        character, in case quotes aren't used (default to
                        character [None]).
  -s GEOMETRY, --size GEOMETRY
                        specify the width and/or height in pixels of the image
                        to build, with the ratio of a CR80 standard credit
                        card size ID-1 in portrait mode (54mm x 85.6mm)
  -p SIZE, --padding SIZE
                        specify the space in pixels or percentage to generate
                        around the ID card
  --header-file FILE    specify the absolute path name of the header image
                        file
  --font-name NAME      specify the name of the font to display the full name
                        of each ID card
  --name-format FORMAT  specify the format of ID card file name
  --debug LEVEL         specify the logging level (value between 0 and 4, from
                        critical to debug)

For example:

$ xidgen --card-type student --header-file lfiduras_logo.jpg --csv-file lfiduras-students.csv

The user can specify the file name of the ID card images by passing the argument name-format. A ID card file name format MUST be composed of field names to build this file name with. These field names MUST be defined in braces, each field names separated with a character underscore. For example:

{id}_{first name}_{grade level}

Note: The accepted field names correspond to the CSV field names.

CSV File

The CSV file passed to the script MUST contain a first row corresponding to the header fields in whatever order:

• # (optional): The identification of the registration file of the card owner (as provided by the organization that manages this list)
• ID (required): The identification of the card owner
• Card Type (optional): Specify the type of the ID card (driver, guardian, securityguard, or student)
• Class Name (optional)
• First Name (optional)
• Full Name (required)
• Grade Level (optional): The number of the year a pupil has reached in this given educational
• Grade Name (optional): THe name given to this grade
• Last Name (optional)

For example:

Available Fonts

Development and Publication

Xebus ID Card Generator uses Poetry, a packaging and dependency management for Python. To install the required packages, execute the following command:

poetry install

To activate the virtual environment, run the following command:

poetry shell

To publish a new version of the library Xebus ID Card Generator to the Python Package Index (PyPI), execute the following command:

poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD

Note: If you are storing the PyPi credentials in a .env file, you can get this file automatically loaded when activating your virtual environment. You need to install the Poetry plugin poetry-dotenv-plugin:

poetry self add poetry-dotenv-plugin