Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
boosterl committed May 30, 2023
1 parent 45af19f commit 3bbb512
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
# eid-image-extractor

## Introduction
This is a small python script to extract the image from a Belgian electronic identity card.

This is a small python script to extract the image from a Belgian electronic
identity card.

## How to install
Before running this script you will need a few dependencies, notably, python 3, pip3 and the python module [eidreader](https://github.com/lino-framework/eidreader).

To install eidreader you will also need to have ```swig``` installed. On an Arch system, the installation looks like this:
All the Python dependencies this script has are declared in the
`requirements.txt`-file. The script can be ran in a `venv`:
```
sudo pacman -S python3 swig
sudo pip install eidreader
python3 -m venv .
source ./bin/activate
pip install -r requirements.txt
```

## How to use
After you installed the dependencies, you can just run the script:

After you installed the dependencies, you can just run the script inside the
`venv`:
```
python3 eid-image-extractor.py
```
After this, if everything went well, you will see a file with the name ```{NATIONAL_NUMBER}.jpeg``` next to the script.
After this, if everything went well, you will see a file with the name
```{NATIONAL_NUMBER}.jpeg``` next to the script.

0 comments on commit 3bbb512

Please sign in to comment.